From 65955a7c91d54febcd32c48375cd09c0545bb63d Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 10 Jan 2024 16:07:32 +0000 Subject: [PATCH] false[adyen-sdk-automation] automated change --- .../com/adyen/model/acswebhooks/Amount.java | 10 + .../model/acswebhooks/AuthenticationInfo.java | 75 ++ .../AuthenticationNotificationData.java | 30 + .../AuthenticationNotificationRequest.java | 15 + .../BalancePlatformNotificationResponse.java | 5 + .../model/acswebhooks/ChallengeInfo.java | 30 + .../adyen/model/acswebhooks/PurchaseInfo.java | 15 + .../com/adyen/model/acswebhooks/Resource.java | 15 + .../balancecontrol/AbstractOpenApiSchema.java | 1 - .../adyen/model/balancecontrol/Amount.java | 11 +- .../BalanceTransferRequest.java | 31 +- .../BalanceTransferResponse.java | 46 +- .../AULocalAccountIdentification.java | 15 + .../model/balanceplatform/AccountHolder.java | 65 ++ .../AccountHolderCapability.java | 50 + .../balanceplatform/AccountHolderInfo.java | 45 + .../AccountHolderUpdateRequest.java | 55 ++ .../AccountSupportingEntityCapability.java | 35 + .../ActiveNetworkTokensRestriction.java | 10 + .../AdditionalBankIdentification.java | 10 + .../adyen/model/balanceplatform/Address.java | 30 + .../balanceplatform/AddressRequirement.java | 15 + .../adyen/model/balanceplatform/Amount.java | 10 + .../AmountMinMaxRequirement.java | 20 + .../model/balanceplatform/Authentication.java | 15 + .../BRLocalAccountIdentification.java | 20 + .../adyen/model/balanceplatform/Balance.java | 25 + .../model/balanceplatform/BalanceAccount.java | 55 ++ .../balanceplatform/BalanceAccountBase.java | 50 + .../balanceplatform/BalanceAccountInfo.java | 40 + .../BalanceAccountUpdateRequest.java | 35 + .../balanceplatform/BalancePlatform.java | 15 + .../BalanceSweepConfigurationsResponse.java | 15 + .../model/balanceplatform/BankAccount.java | 5 + ...kAccountIdentificationTypeRequirement.java | 15 + ...ccountIdentificationValidationRequest.java | 5 + .../balanceplatform/BankIdentification.java | 15 + .../BrandVariantsRestriction.java | 10 + .../model/balanceplatform/BulkAddress.java | 45 + .../CALocalAccountIdentification.java | 25 + .../CZLocalAccountIdentification.java | 15 + .../balanceplatform/CapabilityProblem.java | 10 + .../CapabilityProblemEntity.java | 20 + .../CapabilityProblemEntityRecursive.java | 15 + .../balanceplatform/CapabilitySettings.java | 25 + .../model/balanceplatform/CapitalBalance.java | 20 + .../balanceplatform/CapitalGrantAccount.java | 20 + .../com/adyen/model/balanceplatform/Card.java | 65 ++ .../balanceplatform/CardConfiguration.java | 70 ++ .../adyen/model/balanceplatform/CardInfo.java | 40 + .../model/balanceplatform/ContactDetails.java | 20 + .../model/balanceplatform/Counterparty.java | 10 + .../CounterpartyBankRestriction.java | 10 + .../balanceplatform/CountriesRestriction.java | 10 + .../CreateSweepConfigurationV2.java | 60 ++ .../DKLocalAccountIdentification.java | 15 + .../balanceplatform/DayOfWeekRestriction.java | 10 + .../balanceplatform/DeliveryAddress.java | 35 + .../balanceplatform/DeliveryContact.java | 30 + .../model/balanceplatform/DeviceInfo.java | 55 ++ .../DifferentCurrenciesRestriction.java | 10 + .../adyen/model/balanceplatform/Duration.java | 10 + .../EntryModesRestriction.java | 10 + .../adyen/model/balanceplatform/Expiry.java | 10 + .../com/adyen/model/balanceplatform/Fee.java | 5 + .../GetNetworkTokenResponse.java | 5 + .../balanceplatform/GetTaxFormResponse.java | 10 + .../model/balanceplatform/GrantLimit.java | 5 + .../model/balanceplatform/GrantOffer.java | 40 + .../model/balanceplatform/GrantOffers.java | 5 + .../HKLocalAccountIdentification.java | 15 + .../HULocalAccountIdentification.java | 10 + .../IbanAccountIdentification.java | 10 + .../InternationalTransactionRestriction.java | 10 + .../model/balanceplatform/InvalidField.java | 15 + .../ListNetworkTokensResponse.java | 5 + .../MatchingTransactionsRestriction.java | 10 + .../balanceplatform/MccsRestriction.java | 10 + .../balanceplatform/MerchantAcquirerPair.java | 10 + .../MerchantNamesRestriction.java | 10 + .../balanceplatform/MerchantsRestriction.java | 10 + .../NOLocalAccountIdentification.java | 10 + .../NZLocalAccountIdentification.java | 10 + .../com/adyen/model/balanceplatform/Name.java | 10 + .../model/balanceplatform/NetworkToken.java | 40 + .../NumberAndBicAccountIdentification.java | 20 + .../PLLocalAccountIdentification.java | 10 + .../PaginatedAccountHoldersResponse.java | 15 + .../PaginatedBalanceAccountsResponse.java | 15 + .../PaginatedPaymentInstrumentsResponse.java | 15 + .../balanceplatform/PaymentInstrument.java | 55 ++ .../PaymentInstrumentGroup.java | 30 + .../PaymentInstrumentGroupInfo.java | 25 + .../PaymentInstrumentInfo.java | 45 + .../PaymentInstrumentRequirement.java | 25 + .../PaymentInstrumentRevealInfo.java | 15 + .../PaymentInstrumentUpdateRequest.java | 25 + .../adyen/model/balanceplatform/Phone.java | 10 + .../model/balanceplatform/PhoneNumber.java | 15 + .../PlatformPaymentConfiguration.java | 10 + .../ProcessingTypesRestriction.java | 10 + .../balanceplatform/RemediatingAction.java | 10 + .../model/balanceplatform/Repayment.java | 15 + .../model/balanceplatform/RepaymentTerm.java | 10 + .../balanceplatform/RestServiceError.java | 45 + .../SELocalAccountIdentification.java | 15 + .../SGLocalAccountIdentification.java | 15 + .../SameAmountRestriction.java | 10 + .../SameCounterpartyRestriction.java | 10 + .../model/balanceplatform/StringMatch.java | 10 + .../balanceplatform/SweepConfigurationV2.java | 65 ++ .../balanceplatform/SweepCounterparty.java | 15 + .../model/balanceplatform/SweepSchedule.java | 10 + .../balanceplatform/ThresholdRepayment.java | 5 + .../model/balanceplatform/TimeOfDay.java | 10 + .../balanceplatform/TimeOfDayRestriction.java | 10 + .../TotalAmountRestriction.java | 10 + .../balanceplatform/TransactionRule.java | 70 ++ .../TransactionRuleEntityKey.java | 10 + .../balanceplatform/TransactionRuleInfo.java | 65 ++ .../TransactionRuleInterval.java | 30 + .../TransactionRuleResponse.java | 5 + .../TransactionRuleRestrictions.java | 85 ++ .../TransactionRulesResponse.java | 5 + .../model/balanceplatform/TransferRoute.java | 25 + .../balanceplatform/TransferRouteRequest.java | 35 + .../TransferRouteResponse.java | 5 + .../UKLocalAccountIdentification.java | 15 + .../USLocalAccountIdentification.java | 20 + .../UpdateNetworkTokenRequest.java | 5 + .../UpdatePaymentInstrument.java | 60 ++ .../UpdateSweepConfigurationV2.java | 65 ++ .../balanceplatform/VerificationDeadline.java | 15 + .../balanceplatform/VerificationError.java | 30 + .../VerificationErrorRecursive.java | 25 + .../binlookup/AbstractOpenApiSchema.java | 1 - .../com/adyen/model/binlookup/Amount.java | 11 +- .../com/adyen/model/binlookup/BinDetail.java | 6 +- .../com/adyen/model/binlookup/CardBin.java | 56 +- .../binlookup/CostEstimateAssumptions.java | 16 +- .../model/binlookup/CostEstimateRequest.java | 51 +- .../model/binlookup/CostEstimateResponse.java | 26 +- .../model/binlookup/DSPublicKeyDetail.java | 26 +- .../model/binlookup/MerchantDetails.java | 16 +- .../com/adyen/model/binlookup/Recurring.java | 26 +- .../adyen/model/binlookup/ServiceError.java | 31 +- .../binlookup/ThreeDS2CardRangeDetail.java | 31 +- .../binlookup/ThreeDSAvailabilityRequest.java | 31 +- .../ThreeDSAvailabilityResponse.java | 26 +- .../com/adyen/model/checkout/AccountInfo.java | 95 ++ .../com/adyen/model/checkout/AcctInfo.java | 80 ++ .../com/adyen/model/checkout/AchDetails.java | 50 + .../checkout/AdditionalData3DSecure.java | 30 + .../model/checkout/AdditionalDataAirline.java | 140 +++ .../checkout/AdditionalDataCarRental.java | 115 +++ .../model/checkout/AdditionalDataCommon.java | 80 ++ .../model/checkout/AdditionalDataLevel23.java | 85 ++ .../model/checkout/AdditionalDataLodging.java | 80 ++ .../checkout/AdditionalDataOpenInvoice.java | 90 ++ .../model/checkout/AdditionalDataOpi.java | 5 + .../model/checkout/AdditionalDataRatepay.java | 40 + .../model/checkout/AdditionalDataRetry.java | 15 + .../model/checkout/AdditionalDataRisk.java | 105 +++ .../AdditionalDataRiskStandalone.java | 75 ++ .../checkout/AdditionalDataSubMerchant.java | 50 + .../AdditionalDataTemporaryServices.java | 45 + .../model/checkout/AdditionalDataWallets.java | 30 + .../com/adyen/model/checkout/Address.java | 30 + .../adyen/model/checkout/AfterpayDetails.java | 35 + .../model/checkout/AmazonPayDetails.java | 20 + .../java/com/adyen/model/checkout/Amount.java | 10 + .../model/checkout/AndroidPayDetails.java | 10 + .../adyen/model/checkout/ApplePayDetails.java | 30 + .../model/checkout/ApplePayDonations.java | 384 ++++++++ .../checkout/ApplePaySessionRequest.java | 15 + .../checkout/ApplePaySessionResponse.java | 5 + .../adyen/model/checkout/ApplicationInfo.java | 30 + .../model/checkout/AuthenticationData.java | 15 + .../java/com/adyen/model/checkout/Avs.java | 10 + .../checkout/BacsDirectDebitDetails.java | 35 + .../model/checkout/BalanceCheckRequest.java | 220 +++++ .../model/checkout/BalanceCheckResponse.java | 35 + .../com/adyen/model/checkout/BankAccount.java | 45 + .../adyen/model/checkout/BillDeskDetails.java | 23 +- .../adyen/model/checkout/BillingAddress.java | 30 + .../com/adyen/model/checkout/BlikDetails.java | 25 + .../com/adyen/model/checkout/BrowserInfo.java | 45 + .../model/checkout/CancelOrderRequest.java | 10 + .../model/checkout/CancelOrderResponse.java | 10 + .../java/com/adyen/model/checkout/Card.java | 40 + .../model/checkout/CardBrandDetails.java | 10 + .../com/adyen/model/checkout/CardDetails.java | 99 ++ .../model/checkout/CardDetailsRequest.java | 25 + .../model/checkout/CardDetailsResponse.java | 5 + .../adyen/model/checkout/CardDonations.java | 863 ++++++++++++++++++ .../model/checkout/CellulantDetails.java | 15 + .../model/checkout/CheckoutAwaitAction.java | 20 + ...CheckoutDelegatedAuthenticationAction.java | 30 + .../CheckoutNativeRedirectAction.java | 30 + .../model/checkout/CheckoutOrderResponse.java | 30 + .../model/checkout/CheckoutQrCodeAction.java | 30 + .../checkout/CheckoutRedirectAction.java | 25 + .../model/checkout/CheckoutSDKAction.java | 25 + .../CheckoutSessionInstallmentOption.java | 15 + .../checkout/CheckoutThreeDS2Action.java | 35 + .../model/checkout/CheckoutVoucherAction.java | 105 +++ .../com/adyen/model/checkout/CommonField.java | 10 + .../com/adyen/model/checkout/Company.java | 30 + .../CreateCheckoutSessionRequest.java | 328 ++++++- .../CreateCheckoutSessionResponse.java | 343 ++++++- .../model/checkout/CreateOrderRequest.java | 20 + .../model/checkout/CreateOrderResponse.java | 50 + .../adyen/model/checkout/DeliveryAddress.java | 40 + .../DetailsRequestAuthenticationData.java | 5 + .../model/checkout/DeviceRenderOptions.java | 10 + .../com/adyen/model/checkout/DokuDetails.java | 25 + .../model/checkout/DonationPaymentMethod.java | 198 ++-- .../checkout/DonationPaymentRequest.java | 207 ++++- .../checkout/DonationPaymentResponse.java | 35 + .../adyen/model/checkout/DotpayDetails.java | 15 + .../model/checkout/DragonpayDetails.java | 20 + .../checkout/EcontextVoucherDetails.java | 30 + .../model/checkout/EncryptedOrderData.java | 10 + .../model/checkout/ExternalPlatform.java | 15 + .../com/adyen/model/checkout/ForexQuote.java | 60 ++ .../model/checkout/FraudCheckResult.java | 15 + .../com/adyen/model/checkout/FraudResult.java | 10 + .../com/adyen/model/checkout/FundOrigin.java | 124 ++- .../adyen/model/checkout/FundRecipient.java | 50 + .../GenericIssuerPaymentMethodDetails.java | 25 + .../adyen/model/checkout/GiropayDetails.java | 20 + .../model/checkout/GooglePayDetails.java | 68 +- .../model/checkout/GooglePayDonations.java | 420 +++++++++ .../adyen/model/checkout/IdealDetails.java | 25 + .../adyen/model/checkout/IdealDonations.java | 313 +++++++ .../com/adyen/model/checkout/InputDetail.java | 45 + .../model/checkout/InstallmentOption.java | 20 + .../adyen/model/checkout/Installments.java | 10 + .../model/checkout/InstallmentsNumber.java | 5 + .../java/com/adyen/model/checkout/Item.java | 10 + .../adyen/model/checkout/KlarnaDetails.java | 40 + .../com/adyen/model/checkout/LineItem.java | 85 ++ .../ListStoredPaymentMethodsResponse.java | 15 + .../com/adyen/model/checkout/Mandate.java | 40 + .../model/checkout/MasterpassDetails.java | 20 + .../adyen/model/checkout/MbwayDetails.java | 20 + .../adyen/model/checkout/MerchantDevice.java | 15 + .../model/checkout/MerchantRiskIndicator.java | 70 ++ .../model/checkout/MobilePayDetails.java | 10 + .../model/checkout/ModelConfiguration.java | 20 + .../adyen/model/checkout/MolPayDetails.java | 15 + .../java/com/adyen/model/checkout/Name.java | 10 + .../model/checkout/OpenInvoiceDetails.java | 35 + .../adyen/model/checkout/PayPalDetails.java | 45 + .../adyen/model/checkout/PayUUpiDetails.java | 30 + .../model/checkout/PayWithGoogleDetails.java | 30 + .../checkout/PayWithGoogleDonations.java | 384 ++++++++ .../checkout/PaymentAmountUpdateRequest.java | 35 + .../checkout/PaymentAmountUpdateResponse.java | 45 + .../model/checkout/PaymentCancelRequest.java | 15 + .../model/checkout/PaymentCancelResponse.java | 25 + .../model/checkout/PaymentCaptureRequest.java | 40 + .../checkout/PaymentCaptureResponse.java | 50 + .../checkout/PaymentCompletionDetails.java | 90 ++ .../adyen/model/checkout/PaymentDetails.java | 10 + .../model/checkout/PaymentDetailsRequest.java | 20 + .../checkout/PaymentDetailsResponse.java | 75 ++ .../model/checkout/PaymentLinkRequest.java | 190 ++++ .../model/checkout/PaymentLinkResponse.java | 210 +++++ .../adyen/model/checkout/PaymentMethod.java | 45 + .../model/checkout/PaymentMethodGroup.java | 15 + .../model/checkout/PaymentMethodIssuer.java | 15 + .../model/checkout/PaymentMethodsRequest.java | 60 ++ .../checkout/PaymentMethodsResponse.java | 10 + .../model/checkout/PaymentRefundRequest.java | 40 + .../model/checkout/PaymentRefundResponse.java | 50 + .../adyen/model/checkout/PaymentRequest.java | 335 +++++++ .../adyen/model/checkout/PaymentResponse.java | 75 ++ .../checkout/PaymentReversalRequest.java | 15 + .../checkout/PaymentReversalResponse.java | 25 + .../model/checkout/PaymentSetupRequest.java | 280 ++++++ .../model/checkout/PaymentSetupResponse.java | 10 + .../checkout/PaymentVerificationRequest.java | 5 + .../checkout/PaymentVerificationResponse.java | 50 + .../java/com/adyen/model/checkout/Phone.java | 10 + .../checkout/PlatformChargebackLogic.java | 15 + .../adyen/model/checkout/RatepayDetails.java | 35 + .../com/adyen/model/checkout/Recurring.java | 25 + .../adyen/model/checkout/RecurringDetail.java | 55 ++ .../ResponseAdditionalData3DSecure.java | 25 + .../ResponseAdditionalDataBillingAddress.java | 30 + .../checkout/ResponseAdditionalDataCard.java | 40 + .../ResponseAdditionalDataCommon.java | 295 ++++++ .../ResponseAdditionalDataDomesticError.java | 10 + .../ResponseAdditionalDataInstallments.java | 60 ++ .../ResponseAdditionalDataNetworkTokens.java | 15 + .../checkout/ResponseAdditionalDataOpi.java | 5 + .../checkout/ResponseAdditionalDataSepa.java | 15 + .../model/checkout/ResponsePaymentMethod.java | 10 + .../com/adyen/model/checkout/RiskData.java | 20 + .../adyen/model/checkout/SDKEphemPubKey.java | 20 + .../model/checkout/SamsungPayDetails.java | 30 + .../checkout/SepaDirectDebitDetails.java | 30 + .../adyen/model/checkout/ServiceError.java | 30 + .../model/checkout/ServiceErrorDetails.java | 20 + .../model/checkout/SessionResultResponse.java | 10 + .../adyen/model/checkout/ShopperInput.java | 15 + .../checkout/ShopperInteractionDevice.java | 15 + .../java/com/adyen/model/checkout/Split.java | 25 + .../com/adyen/model/checkout/SplitAmount.java | 10 + .../StandalonePaymentCancelRequest.java | 20 + .../StandalonePaymentCancelResponse.java | 25 + .../adyen/model/checkout/StoredDetails.java | 15 + .../model/checkout/StoredPaymentMethod.java | 85 ++ .../checkout/StoredPaymentMethodDetails.java | 20 + .../checkout/StoredPaymentMethodResource.java | 85 ++ .../adyen/model/checkout/SubInputDetail.java | 30 + .../com/adyen/model/checkout/SubMerchant.java | 25 + .../adyen/model/checkout/SubMerchantInfo.java | 25 + .../model/checkout/ThreeDS2RequestData.java | 195 ++++ .../model/checkout/ThreeDS2RequestFields.java | 180 ++++ .../model/checkout/ThreeDS2ResponseData.java | 95 ++ .../adyen/model/checkout/ThreeDS2Result.java | 70 ++ .../model/checkout/ThreeDSRequestData.java | 20 + .../ThreeDSRequestorAuthenticationInfo.java | 15 + ...reeDSRequestorPriorAuthenticationInfo.java | 20 + .../model/checkout/ThreeDSecureData.java | 60 ++ .../checkout/UpdatePaymentLinkRequest.java | 5 + .../model/checkout/UpiCollectDetails.java | 35 + .../model/checkout/UpiIntentDetails.java | 25 + .../adyen/model/checkout/UtilityRequest.java | 5 + .../adyen/model/checkout/UtilityResponse.java | 5 + .../adyen/model/checkout/VippsDetails.java | 25 + .../model/checkout/VisaCheckoutDetails.java | 20 + .../model/checkout/WeChatPayDetails.java | 10 + .../checkout/WeChatPayMiniProgramDetails.java | 20 + .../com/adyen/model/checkout/ZipDetails.java | 25 + .../configurationwebhooks/AccountHolder.java | 65 ++ .../AccountHolderCapability.java | 50 + .../AccountHolderNotificationData.java | 10 + .../AccountHolderNotificationRequest.java | 15 + .../AccountSupportingEntityCapability.java | 35 + .../model/configurationwebhooks/Address.java | 30 + .../model/configurationwebhooks/Amount.java | 10 + .../configurationwebhooks/Authentication.java | 15 + .../model/configurationwebhooks/Balance.java | 25 + .../configurationwebhooks/BalanceAccount.java | 60 ++ .../BalanceAccountNotificationData.java | 10 + .../BalanceAccountNotificationRequest.java | 15 + .../BalancePlatformNotificationResponse.java | 5 + .../configurationwebhooks/BulkAddress.java | 45 + .../CapabilityProblem.java | 10 + .../CapabilityProblemEntity.java | 20 + .../CapabilityProblemEntityRecursive.java | 15 + .../CapabilitySettings.java | 25 + .../model/configurationwebhooks/Card.java | 65 ++ .../CardConfiguration.java | 70 ++ .../configurationwebhooks/CardOrderItem.java | 40 + .../CardOrderItemDeliveryStatus.java | 15 + .../CardOrderNotificationRequest.java | 15 + .../model/configurationwebhooks/Contact.java | 35 + .../configurationwebhooks/ContactDetails.java | 20 + .../model/configurationwebhooks/Expiry.java | 10 + .../IbanAccountIdentification.java | 10 + .../model/configurationwebhooks/Name.java | 10 + .../PaymentInstrument.java | 50 + .../PaymentInstrumentNotificationData.java | 10 + .../PaymentInstrumentReference.java | 5 + .../PaymentNotificationRequest.java | 15 + .../configurationwebhooks/PersonalData.java | 15 + .../model/configurationwebhooks/Phone.java | 10 + .../configurationwebhooks/PhoneNumber.java | 15 + .../PlatformPaymentConfiguration.java | 10 + .../RemediatingAction.java | 10 + .../model/configurationwebhooks/Resource.java | 15 + .../SweepConfigurationNotificationData.java | 15 + ...SweepConfigurationNotificationRequest.java | 15 + .../SweepConfigurationV2.java | 55 ++ .../SweepCounterparty.java | 15 + .../configurationwebhooks/SweepSchedule.java | 10 + .../USLocalAccountIdentification.java | 20 + .../VerificationDeadline.java | 15 + .../VerificationError.java | 30 + .../VerificationErrorRecursive.java | 25 + .../dataprotection/AbstractOpenApiSchema.java | 1 - .../model/dataprotection/ServiceError.java | 26 +- .../SubjectErasureByPspReferenceRequest.java | 16 +- .../SubjectErasureResponse.java | 6 +- .../model/disputes/AbstractOpenApiSchema.java | 1 - .../model/disputes/AcceptDisputeRequest.java | 11 +- .../model/disputes/AcceptDisputeResponse.java | 6 +- .../model/disputes/DefendDisputeRequest.java | 16 +- .../model/disputes/DefendDisputeResponse.java | 6 +- .../adyen/model/disputes/DefenseDocument.java | 16 +- .../model/disputes/DefenseDocumentType.java | 16 +- .../adyen/model/disputes/DefenseReason.java | 16 +- .../model/disputes/DefenseReasonsRequest.java | 11 +- .../disputes/DefenseReasonsResponse.java | 11 +- .../DeleteDefenseDocumentRequest.java | 16 +- .../DeleteDefenseDocumentResponse.java | 6 +- .../model/disputes/DisputeServiceResult.java | 11 +- .../adyen/model/disputes/ServiceError.java | 26 +- .../SupplyDefenseDocumentRequest.java | 16 +- .../SupplyDefenseDocumentResponse.java | 6 +- .../AULocalAccountIdentification.java | 15 + .../AcceptTermsOfServiceRequest.java | 10 + .../AcceptTermsOfServiceResponse.java | 30 + .../AdditionalBankIdentification.java | 10 + .../model/legalentitymanagement/Address.java | 30 + .../model/legalentitymanagement/Amount.java | 10 + .../legalentitymanagement/Attachment.java | 25 + .../BankAccountInfo.java | 25 + .../legalentitymanagement/BirthData.java | 5 + .../legalentitymanagement/BusinessLine.java | 54 +- .../BusinessLineInfo.java | 44 +- .../BusinessLineInfoUpdate.java | 40 + .../legalentitymanagement/BusinessLines.java | 5 + .../CALocalAccountIdentification.java | 25 + .../CZLocalAccountIdentification.java | 15 + ...CalculateTermsOfServiceStatusResponse.java | 5 + .../CapabilityProblem.java | 10 + .../CapabilityProblemEntity.java | 20 + .../CapabilityProblemEntityRecursive.java | 15 + .../CapabilitySettings.java | 25 + .../DKLocalAccountIdentification.java | 15 + .../DataReviewConfirmationResponse.java | 5 + .../model/legalentitymanagement/Document.java | 65 ++ .../legalentitymanagement/DocumentPage.java | 15 + .../DocumentReference.java | 35 + .../EntityReference.java | 5 + .../GeneratePciDescriptionRequest.java | 10 + .../GeneratePciDescriptionResponse.java | 15 + .../GetPciQuestionnaireInfosResponse.java | 5 + .../GetPciQuestionnaireResponse.java | 20 + ...TermsOfServiceAcceptanceInfosResponse.java | 5 + .../GetTermsOfServiceDocumentRequest.java | 10 + .../GetTermsOfServiceDocumentResponse.java | 25 + .../HKLocalAccountIdentification.java | 15 + .../HULocalAccountIdentification.java | 10 + .../IbanAccountIdentification.java | 10 + .../IdentificationData.java | 35 + .../legalentitymanagement/Individual.java | 45 + .../legalentitymanagement/LegalEntity.java | 117 ++- .../LegalEntityAssociation.java | 35 + .../LegalEntityCapability.java | 40 + .../LegalEntityInfo.java | 87 +- .../LegalEntityInfoRequiredType.java | 87 +- .../NOLocalAccountIdentification.java | 10 + .../NZLocalAccountIdentification.java | 10 + .../model/legalentitymanagement/Name.java | 15 + .../NumberAndBicAccountIdentification.java | 20 + .../legalentitymanagement/OnboardingLink.java | 5 + .../OnboardingLinkInfo.java | 20 + .../OnboardingTheme.java | 25 + .../OnboardingThemes.java | 15 + .../legalentitymanagement/Organization.java | 80 ++ .../legalentitymanagement/OwnerEntity.java | 10 + .../PLLocalAccountIdentification.java | 10 + .../PciDocumentInfo.java | 15 + .../PciSigningRequest.java | 10 + .../PciSigningResponse.java | 10 + .../legalentitymanagement/PhoneNumber.java | 10 + .../RemediatingAction.java | 10 + .../SELocalAccountIdentification.java | 15 + .../SGLocalAccountIdentification.java | 15 + .../legalentitymanagement/ServiceError.java | 25 + .../SoleProprietorship.java | 55 ++ .../legalentitymanagement/SourceOfFunds.java | 20 + .../legalentitymanagement/StockData.java | 15 + .../SupportingEntityCapability.java | 20 + .../legalentitymanagement/TaxInformation.java | 15 + .../TaxReportingClassification.java | 20 + .../TermsOfServiceAcceptanceInfo.java | 25 + .../TransferInstrument.java | 35 + .../TransferInstrumentInfo.java | 15 + .../TransferInstrumentReference.java | 20 + .../model/legalentitymanagement/Trust.java | 65 ++ .../UKLocalAccountIdentification.java | 15 + .../USLocalAccountIdentification.java | 20 + .../UndefinedBeneficiary.java | 10 + .../UnincorporatedPartnership.java | 66 +- .../VerificationDeadline.java | 15 + .../VerificationError.java | 30 + .../VerificationErrorRecursive.java | 25 + .../VerificationErrors.java | 5 + .../model/legalentitymanagement/WebData.java | 10 + .../WebDataExemption.java | 5 + .../management/AdditionalCommission.java | 15 + .../model/management/AdditionalSettings.java | 10 + .../AdditionalSettingsResponse.java | 15 + .../com/adyen/model/management/Address.java | 35 + .../model/management/AfterpayTouchInfo.java | 5 + .../adyen/model/management/AllowedOrigin.java | 15 + .../management/AllowedOriginsResponse.java | 5 + .../com/adyen/model/management/Amount.java | 10 + .../adyen/model/management/AndroidApp.java | 40 + .../model/management/AndroidAppsResponse.java | 5 + .../model/management/AndroidCertificate.java | 35 + .../AndroidCertificatesResponse.java | 5 + .../adyen/model/management/ApiCredential.java | 45 + .../model/management/ApiCredentialLinks.java | 30 + .../adyen/model/management/ApplePayInfo.java | 5 + .../com/adyen/model/management/BcmcInfo.java | 10 + .../management/BillingEntitiesResponse.java | 5 + .../adyen/model/management/BillingEntity.java | 25 + .../model/management/CardholderReceipt.java | 5 + .../model/management/CartesBancairesInfo.java | 10 + .../adyen/model/management/ClearpayInfo.java | 5 + .../adyen/model/management/Commission.java | 10 + .../com/adyen/model/management/Company.java | 35 + .../management/CompanyApiCredential.java | 50 + .../adyen/model/management/CompanyLinks.java | 20 + .../adyen/model/management/CompanyUser.java | 55 ++ .../adyen/model/management/Connectivity.java | 5 + .../com/adyen/model/management/Contact.java | 25 + .../CreateAllowedOriginRequest.java | 15 + .../CreateApiCredentialResponse.java | 55 ++ .../CreateCompanyApiCredentialRequest.java | 20 + .../CreateCompanyApiCredentialResponse.java | 60 ++ .../management/CreateCompanyUserRequest.java | 35 + .../management/CreateCompanyUserResponse.java | 55 ++ .../CreateCompanyWebhookRequest.java | 80 ++ .../CreateMerchantApiCredentialRequest.java | 15 + .../management/CreateMerchantRequest.java | 35 + .../management/CreateMerchantResponse.java | 35 + .../management/CreateMerchantUserRequest.java | 30 + .../CreateMerchantWebhookRequest.java | 70 ++ .../model/management/CreateUserResponse.java | 50 + .../com/adyen/model/management/Currency.java | 15 + .../model/management/CustomNotification.java | 35 + .../adyen/model/management/DataCenter.java | 10 + .../com/adyen/model/management/EventUrl.java | 10 + .../management/ExternalTerminalAction.java | 40 + .../management/GenerateApiKeyResponse.java | 5 + .../management/GenerateClientKeyResponse.java | 5 + .../management/GenerateHmacKeyResponse.java | 5 + .../management/GenericPmWithTdiInfo.java | 5 + .../adyen/model/management/GiroPayInfo.java | 5 + .../adyen/model/management/GooglePayInfo.java | 10 + .../com/adyen/model/management/Gratuity.java | 20 + .../com/adyen/model/management/Hardware.java | 52 +- .../com/adyen/model/management/IdName.java | 10 + .../management/InstallAndroidAppDetails.java | 10 + .../InstallAndroidCertificateDetails.java | 10 + .../adyen/model/management/InvalidField.java | 15 + .../java/com/adyen/model/management/Key.java | 15 + .../adyen/model/management/KlarnaInfo.java | 20 + .../com/adyen/model/management/Links.java | 5 + .../adyen/model/management/LinksElement.java | 5 + .../ListCompanyApiCredentialsResponse.java | 20 + .../model/management/ListCompanyResponse.java | 20 + .../management/ListCompanyUsersResponse.java | 20 + .../ListExternalTerminalActionsResponse.java | 5 + .../ListMerchantApiCredentialsResponse.java | 20 + .../management/ListMerchantResponse.java | 20 + .../management/ListMerchantUsersResponse.java | 20 + .../model/management/ListStoresResponse.java | 20 + .../management/ListTerminalsResponse.java | 20 + .../management/ListWebhooksResponse.java | 25 + .../adyen/model/management/Localization.java | 47 +- .../java/com/adyen/model/management/Logo.java | 5 + .../model/management/MeApiCredential.java | 55 ++ .../model/management/MealVoucherFRInfo.java | 15 + .../com/adyen/model/management/Merchant.java | 70 ++ .../adyen/model/management/MerchantLinks.java | 20 + .../management/MinorUnitsMonetaryValue.java | 10 + .../model/management/ModelConfiguration.java | 20 + .../com/adyen/model/management/ModelFile.java | 10 + .../java/com/adyen/model/management/Name.java | 10 + .../com/adyen/model/management/Name2.java | 10 + .../java/com/adyen/model/management/Nexo.java | 25 + .../adyen/model/management/Notification.java | 5 + .../model/management/NotificationUrl.java | 10 + .../model/management/OfflineProcessing.java | 10 + .../java/com/adyen/model/management/Opi.java | 15 + .../com/adyen/model/management/OrderItem.java | 20 + .../model/management/PaginationLinks.java | 25 + .../com/adyen/model/management/Passcodes.java | 20 + .../adyen/model/management/PayAtTable.java | 10 + .../adyen/model/management/PayPalInfo.java | 15 + .../com/adyen/model/management/Payment.java | 10 + .../adyen/model/management/PaymentMethod.java | 185 ++++ .../management/PaymentMethodResponse.java | 25 + .../management/PaymentMethodSetupInfo.java | 165 ++++ .../model/management/PayoutSettings.java | 35 + .../management/PayoutSettingsRequest.java | 15 + .../management/PayoutSettingsResponse.java | 5 + .../com/adyen/model/management/Profile.java | 90 ++ .../model/management/ReceiptOptions.java | 48 +- .../model/management/ReceiptPrinting.java | 80 ++ .../management/ReleaseUpdateDetails.java | 10 + .../management/RequestActivationResponse.java | 10 + .../model/management/RestServiceError.java | 45 + .../ScheduleTerminalActionsRequest.java | 20 + .../ScheduleTerminalActionsResponse.java | 35 + .../com/adyen/model/management/Settings.java | 15 + .../model/management/ShippingLocation.java | 20 + .../management/ShippingLocationsResponse.java | 5 + .../com/adyen/model/management/Signature.java | 20 + .../adyen/model/management/SofortInfo.java | 10 + .../model/management/SplitConfiguration.java | 20 + .../management/SplitConfigurationList.java | 5 + .../management/SplitConfigurationLogic.java | 75 ++ .../management/SplitConfigurationRule.java | 30 + .../adyen/model/management/Standalone.java | 10 + .../com/adyen/model/management/Store.java | 60 ++ .../management/StoreCreationRequest.java | 40 + .../StoreCreationWithMerchantCodeRequest.java | 45 + .../adyen/model/management/StoreLocation.java | 35 + .../management/StoreSplitConfiguration.java | 10 + .../com/adyen/model/management/Surcharge.java | 10 + .../com/adyen/model/management/SwishInfo.java | 5 + .../com/adyen/model/management/TapToPay.java | 133 +++ .../com/adyen/model/management/Terminal.java | 40 + .../TerminalActionScheduleDetail.java | 10 + .../model/management/TerminalAssignment.java | 25 + .../management/TerminalConnectivity.java | 20 + .../TerminalConnectivityBluetooth.java | 10 + .../TerminalConnectivityCellular.java | 10 + .../TerminalConnectivityEthernet.java | 15 + .../management/TerminalConnectivityWifi.java | 15 + .../management/TerminalModelsResponse.java | 5 + .../adyen/model/management/TerminalOrder.java | 40 + .../management/TerminalOrderRequest.java | 30 + .../management/TerminalOrdersResponse.java | 5 + .../model/management/TerminalProduct.java | 25 + .../management/TerminalProductPrice.java | 10 + .../management/TerminalProductsResponse.java | 5 + .../TerminalReassignmentRequest.java | 20 + .../TerminalReassignmentTarget.java | 20 + .../model/management/TerminalSettings.java | 129 ++- .../management/TestCompanyWebhookRequest.java | 15 + .../adyen/model/management/TestOutput.java | 30 + .../model/management/TestWebhookRequest.java | 10 + .../model/management/TestWebhookResponse.java | 5 + .../com/adyen/model/management/Timeouts.java | 5 + .../TransactionDescriptionInfo.java | 10 + .../com/adyen/model/management/TwintInfo.java | 5 + .../UninstallAndroidAppDetails.java | 10 + .../UninstallAndroidCertificateDetails.java | 10 + .../model/management/UpdatableAddress.java | 30 + .../UpdateCompanyApiCredentialRequest.java | 25 + .../management/UpdateCompanyUserRequest.java | 35 + .../UpdateCompanyWebhookRequest.java | 75 ++ .../UpdateMerchantApiCredentialRequest.java | 20 + .../management/UpdateMerchantUserRequest.java | 30 + .../UpdateMerchantWebhookRequest.java | 65 ++ .../management/UpdatePaymentMethodInfo.java | 85 ++ .../UpdatePayoutSettingsRequest.java | 5 + .../UpdateSplitConfigurationLogicRequest.java | 75 ++ .../UpdateSplitConfigurationRequest.java | 5 + .../UpdateSplitConfigurationRuleRequest.java | 20 + .../model/management/UpdateStoreRequest.java | 35 + .../management/UploadAndroidAppResponse.java | 5 + .../java/com/adyen/model/management/Url.java | 20 + .../java/com/adyen/model/management/User.java | 50 + .../com/adyen/model/management/VippsInfo.java | 10 + .../com/adyen/model/management/Webhook.java | 110 +++ .../adyen/model/management/WebhookLinks.java | 25 + .../adyen/model/management/WifiProfiles.java | 10 + .../AccountCapabilityData.java | 74 +- .../AccountCreateNotificationData.java | 25 + .../AccountNotificationResponse.java | 5 + .../AccountUpdateNotificationData.java | 20 + .../managementwebhooks/CapabilityProblem.java | 10 + .../CapabilityProblemEntity.java | 20 + .../CapabilityProblemEntityRecursive.java | 15 + .../MerchantCreatedNotificationRequest.java | 20 + .../MerchantUpdatedNotificationRequest.java | 20 + .../MidServiceNotificationData.java | 51 +- ...ymentMethodCreatedNotificationRequest.java | 20 + .../PaymentMethodNotificationResponse.java | 5 + ...thodRequestRemovedNotificationRequest.java | 20 + ...cheduledForRemovalNotificationRequest.java | 20 + .../managementwebhooks/RemediatingAction.java | 10 + .../managementwebhooks/VerificationError.java | 25 + .../VerificationErrorRecursive.java | 20 + .../model/payment/AbstractOpenApiSchema.java | 1 - .../com/adyen/model/payment/AccountInfo.java | 96 +- .../com/adyen/model/payment/AcctInfo.java | 81 +- .../model/payment/AdditionalData3DSecure.java | 31 +- .../model/payment/AdditionalDataAirline.java | 141 ++- .../payment/AdditionalDataCarRental.java | 116 ++- .../model/payment/AdditionalDataCommon.java | 81 +- .../model/payment/AdditionalDataLevel23.java | 86 +- .../model/payment/AdditionalDataLodging.java | 81 +- .../payment/AdditionalDataModifications.java | 6 +- .../payment/AdditionalDataOpenInvoice.java | 91 +- .../model/payment/AdditionalDataOpi.java | 6 +- .../model/payment/AdditionalDataRatepay.java | 41 +- .../model/payment/AdditionalDataRetry.java | 16 +- .../model/payment/AdditionalDataRisk.java | 106 ++- .../payment/AdditionalDataRiskStandalone.java | 76 +- .../payment/AdditionalDataSubMerchant.java | 51 +- .../AdditionalDataTemporaryServices.java | 46 +- .../model/payment/AdditionalDataWallets.java | 31 +- .../java/com/adyen/model/payment/Address.java | 31 +- .../payment/AdjustAuthorisationRequest.java | 56 +- .../java/com/adyen/model/payment/Amount.java | 11 +- .../adyen/model/payment/ApplicationInfo.java | 31 +- .../payment/AuthenticationResultRequest.java | 11 +- .../payment/AuthenticationResultResponse.java | 11 +- .../com/adyen/model/payment/BankAccount.java | 46 +- .../com/adyen/model/payment/BrowserInfo.java | 46 +- .../model/payment/CancelOrRefundRequest.java | 46 +- .../adyen/model/payment/CancelRequest.java | 51 +- .../adyen/model/payment/CaptureRequest.java | 56 +- .../java/com/adyen/model/payment/Card.java | 41 +- .../com/adyen/model/payment/CommonField.java | 11 +- .../model/payment/DeviceRenderOptions.java | 11 +- .../adyen/model/payment/DonationRequest.java | 31 +- .../adyen/model/payment/ExternalPlatform.java | 16 +- .../com/adyen/model/payment/ForexQuote.java | 61 +- .../adyen/model/payment/FraudCheckResult.java | 16 +- .../payment/FraudCheckResultWrapper.java | 6 +- .../com/adyen/model/payment/FraudResult.java | 11 +- .../adyen/model/payment/FundDestination.java | 46 +- .../com/adyen/model/payment/FundSource.java | 31 +- .../com/adyen/model/payment/Installments.java | 11 +- .../java/com/adyen/model/payment/Mandate.java | 41 +- .../adyen/model/payment/MerchantDevice.java | 16 +- .../model/payment/MerchantRiskIndicator.java | 71 +- .../model/payment/ModificationResult.java | 16 +- .../java/com/adyen/model/payment/Name.java | 11 +- .../adyen/model/payment/PaymentRequest.java | 266 +++++- .../adyen/model/payment/PaymentRequest3d.java | 226 ++++- .../model/payment/PaymentRequest3ds2.java | 226 ++++- .../adyen/model/payment/PaymentResult.java | 56 +- .../java/com/adyen/model/payment/Phone.java | 11 +- .../payment/PlatformChargebackLogic.java | 16 +- .../com/adyen/model/payment/Recurring.java | 26 +- .../adyen/model/payment/RefundRequest.java | 56 +- .../ResponseAdditionalData3DSecure.java | 26 +- .../ResponseAdditionalDataBillingAddress.java | 31 +- .../payment/ResponseAdditionalDataCard.java | 41 +- .../payment/ResponseAdditionalDataCommon.java | 296 +++++- .../ResponseAdditionalDataDomesticError.java | 11 +- .../ResponseAdditionalDataInstallments.java | 61 +- .../ResponseAdditionalDataNetworkTokens.java | 16 +- .../payment/ResponseAdditionalDataOpi.java | 6 +- .../payment/ResponseAdditionalDataSepa.java | 16 +- .../adyen/model/payment/SDKEphemPubKey.java | 21 +- .../com/adyen/model/payment/ServiceError.java | 31 +- .../payment/ShopperInteractionDevice.java | 16 +- .../java/com/adyen/model/payment/Split.java | 26 +- .../com/adyen/model/payment/SplitAmount.java | 11 +- .../com/adyen/model/payment/SubMerchant.java | 26 +- .../model/payment/TechnicalCancelRequest.java | 51 +- .../adyen/model/payment/ThreeDS1Result.java | 31 +- .../model/payment/ThreeDS2RequestData.java | 196 +++- .../adyen/model/payment/ThreeDS2Result.java | 71 +- .../model/payment/ThreeDS2ResultRequest.java | 11 +- .../model/payment/ThreeDS2ResultResponse.java | 6 +- .../ThreeDSRequestorAuthenticationInfo.java | 16 +- ...reeDSRequestorPriorAuthenticationInfo.java | 21 +- .../adyen/model/payment/ThreeDSecureData.java | 61 +- .../payment/VoidPendingRefundRequest.java | 56 +- .../java/com/adyen/model/payout/Address.java | 30 + .../java/com/adyen/model/payout/Amount.java | 10 + .../com/adyen/model/payout/BankAccount.java | 45 + .../java/com/adyen/model/payout/Card.java | 40 + .../adyen/model/payout/FraudCheckResult.java | 15 + .../model/payout/FraudCheckResultWrapper.java | 5 + .../com/adyen/model/payout/FraudResult.java | 10 + .../com/adyen/model/payout/FundSource.java | 30 + .../com/adyen/model/payout/ModifyRequest.java | 15 + .../adyen/model/payout/ModifyResponse.java | 15 + .../java/com/adyen/model/payout/Name.java | 10 + .../com/adyen/model/payout/PayoutRequest.java | 70 ++ .../adyen/model/payout/PayoutResponse.java | 55 ++ .../com/adyen/model/payout/Recurring.java | 25 + .../ResponseAdditionalData3DSecure.java | 25 + .../ResponseAdditionalDataBillingAddress.java | 30 + .../payout/ResponseAdditionalDataCard.java | 40 + .../payout/ResponseAdditionalDataCommon.java | 295 ++++++ .../ResponseAdditionalDataDomesticError.java | 10 + .../ResponseAdditionalDataInstallments.java | 60 ++ .../ResponseAdditionalDataNetworkTokens.java | 15 + .../payout/ResponseAdditionalDataOpi.java | 5 + .../payout/ResponseAdditionalDataSepa.java | 15 + .../com/adyen/model/payout/ServiceError.java | 30 + .../payout/StoreDetailAndSubmitRequest.java | 95 ++ .../payout/StoreDetailAndSubmitResponse.java | 20 + .../model/payout/StoreDetailRequest.java | 80 ++ .../model/payout/StoreDetailResponse.java | 20 + .../com/adyen/model/payout/SubmitRequest.java | 75 ++ .../adyen/model/payout/SubmitResponse.java | 20 + .../AbstractOpenApiSchema.java | 1 - .../model/posterminalmanagement/Address.java | 31 +- .../AssignTerminalsRequest.java | 26 +- .../AssignTerminalsResponse.java | 6 +- .../FindTerminalRequest.java | 6 +- .../FindTerminalResponse.java | 26 +- .../GetStoresUnderAccountRequest.java | 11 +- .../GetStoresUnderAccountResponse.java | 6 +- .../GetTerminalDetailsRequest.java | 6 +- .../GetTerminalDetailsResponse.java | 126 ++- .../GetTerminalsUnderAccountRequest.java | 16 +- .../GetTerminalsUnderAccountResponse.java | 16 +- .../MerchantAccount.java | 21 +- .../posterminalmanagement/ServiceError.java | 26 +- .../model/posterminalmanagement/Store.java | 31 +- .../recurring/AbstractOpenApiSchema.java | 1 - .../com/adyen/model/recurring/Address.java | 31 +- .../com/adyen/model/recurring/Amount.java | 11 +- .../adyen/model/recurring/BankAccount.java | 46 +- .../java/com/adyen/model/recurring/Card.java | 41 +- .../model/recurring/CreatePermitRequest.java | 21 +- .../model/recurring/CreatePermitResult.java | 11 +- .../model/recurring/DisablePermitRequest.java | 11 +- .../model/recurring/DisablePermitResult.java | 11 +- .../adyen/model/recurring/DisableRequest.java | 21 +- .../adyen/model/recurring/DisableResult.java | 6 +- .../java/com/adyen/model/recurring/Name.java | 11 +- .../model/recurring/NotifyShopperRequest.java | 46 +- .../model/recurring/NotifyShopperResult.java | 36 +- .../com/adyen/model/recurring/Permit.java | 26 +- .../model/recurring/PermitRestriction.java | 16 +- .../adyen/model/recurring/PermitResult.java | 11 +- .../com/adyen/model/recurring/Recurring.java | 26 +- .../model/recurring/RecurringDetail.java | 86 +- .../recurring/RecurringDetailWrapper.java | 6 +- .../recurring/RecurringDetailsRequest.java | 16 +- .../recurring/RecurringDetailsResult.java | 21 +- .../ScheduleAccountUpdaterRequest.java | 31 +- .../ScheduleAccountUpdaterResult.java | 11 +- .../adyen/model/recurring/ServiceError.java | 31 +- .../adyen/model/recurring/TokenDetails.java | 11 +- .../BalancePlatformNotificationResponse.java | 5 + .../ReportNotificationData.java | 35 + .../ReportNotificationRequest.java | 15 + .../adyen/model/reportwebhooks/Resource.java | 15 + .../reportwebhooks/ResourceReference.java | 15 + .../storedvalue/AbstractOpenApiSchema.java | 1 - .../com/adyen/model/storedvalue/Amount.java | 11 +- .../adyen/model/storedvalue/ServiceError.java | 31 +- .../StoredValueBalanceCheckRequest.java | 41 +- .../StoredValueBalanceCheckResponse.java | 26 +- .../StoredValueBalanceMergeRequest.java | 46 +- .../StoredValueBalanceMergeResponse.java | 31 +- .../storedvalue/StoredValueIssueRequest.java | 41 +- .../storedvalue/StoredValueIssueResponse.java | 36 +- .../storedvalue/StoredValueLoadRequest.java | 46 +- .../storedvalue/StoredValueLoadResponse.java | 31 +- .../StoredValueStatusChangeRequest.java | 46 +- .../StoredValueStatusChangeResponse.java | 31 +- .../storedvalue/StoredValueVoidRequest.java | 31 +- .../storedvalue/StoredValueVoidResponse.java | 26 +- .../model/transactionwebhooks/Amount.java | 10 + .../BalancePlatformNotificationResponse.java | 5 + .../model/transactionwebhooks/Resource.java | 15 + .../ResourceReference.java | 15 + .../transactionwebhooks/Transaction.java | 50 + .../TransactionNotificationRequestV4.java | 15 + .../transactionwebhooks/TransferData.java | 10 + .../AULocalAccountIdentification.java | 15 + .../AdditionalBankIdentification.java | 10 + .../com/adyen/model/transfers/Address.java | 30 + .../com/adyen/model/transfers/Amount.java | 10 + .../BRLocalAccountIdentification.java | 20 + .../adyen/model/transfers/BankAccountV3.java | 10 + .../model/transfers/BankCategoryData.java | 10 + .../CALocalAccountIdentification.java | 25 + .../CZLocalAccountIdentification.java | 15 + .../adyen/model/transfers/CapitalBalance.java | 20 + .../adyen/model/transfers/CapitalGrant.java | 45 + .../model/transfers/CapitalGrantInfo.java | 15 + .../adyen/model/transfers/CapitalGrants.java | 5 + .../adyen/model/transfers/Counterparty.java | 15 + .../model/transfers/CounterpartyInfoV3.java | 15 + .../adyen/model/transfers/CounterpartyV3.java | 20 + .../DKLocalAccountIdentification.java | 15 + .../java/com/adyen/model/transfers/Fee.java | 5 + .../HKLocalAccountIdentification.java | 15 + .../HULocalAccountIdentification.java | 10 + .../transfers/IbanAccountIdentification.java | 10 + .../model/transfers/InternalCategoryData.java | 15 + .../adyen/model/transfers/InvalidField.java | 15 + .../com/adyen/model/transfers/IssuedCard.java | 137 ++- .../java/com/adyen/model/transfers/Link.java | 5 + .../java/com/adyen/model/transfers/Links.java | 10 + .../adyen/model/transfers/MerchantData.java | 25 + .../NOLocalAccountIdentification.java | 10 + .../NZLocalAccountIdentification.java | 10 + .../adyen/model/transfers/NameLocation.java | 30 + .../NumberAndBicAccountIdentification.java | 20 + .../PLLocalAccountIdentification.java | 10 + .../model/transfers/PartyIdentification.java | 35 + .../model/transfers/PaymentInstrument.java | 20 + .../model/transfers/PlatformPayment.java | 30 + .../transfers/RelayedAuthorisationData.java | 10 + .../com/adyen/model/transfers/Repayment.java | 15 + .../adyen/model/transfers/RepaymentTerm.java | 10 + .../model/transfers/ResourceReference.java | 15 + .../model/transfers/RestServiceError.java | 49 +- .../transfers/ReturnTransferRequest.java | 10 + .../transfers/ReturnTransferResponse.java | 26 +- .../SELocalAccountIdentification.java | 15 + .../SGLocalAccountIdentification.java | 15 + .../adyen/model/transfers/ServiceError.java | 25 + .../model/transfers/ThresholdRepayment.java | 5 + .../adyen/model/transfers/Transaction.java | 50 + .../transfers/TransactionSearchResponse.java | 10 + .../com/adyen/model/transfers/Transfer.java | 75 ++ .../adyen/model/transfers/TransferData.java | 10 + .../adyen/model/transfers/TransferInfo.java | 50 + .../TransferNotificationValidationFact.java | 10 + .../UKLocalAccountIdentification.java | 15 + .../USLocalAccountIdentification.java | 20 + .../UltimatePartyIdentification.java | 35 + .../AULocalAccountIdentification.java | 15 + .../AdditionalBankIdentification.java | 10 + .../adyen/model/transferwebhooks/Address.java | 30 + .../adyen/model/transferwebhooks/Amount.java | 10 + .../transferwebhooks/AmountAdjustment.java | 15 + .../BRLocalAccountIdentification.java | 20 + .../transferwebhooks/BalanceMutation.java | 20 + .../BalancePlatformNotificationResponse.java | 5 + .../model/transferwebhooks/BankAccountV3.java | 10 + .../transferwebhooks/BankCategoryData.java | 10 + .../CALocalAccountIdentification.java | 25 + .../CZLocalAccountIdentification.java | 15 + .../transferwebhooks/CounterpartyV3.java | 20 + .../DKLocalAccountIdentification.java | 15 + .../HKLocalAccountIdentification.java | 15 + .../HULocalAccountIdentification.java | 10 + .../IbanAccountIdentification.java | 10 + .../InternalCategoryData.java | 15 + .../model/transferwebhooks/IssuedCard.java | 137 ++- .../model/transferwebhooks/MerchantData.java | 25 + .../model/transferwebhooks/Modification.java | 25 + .../NOLocalAccountIdentification.java | 10 + .../NZLocalAccountIdentification.java | 10 + .../model/transferwebhooks/NameLocation.java | 30 + .../NumberAndBicAccountIdentification.java | 20 + .../PLLocalAccountIdentification.java | 10 + .../transferwebhooks/PartyIdentification.java | 35 + .../transferwebhooks/PaymentInstrument.java | 20 + .../transferwebhooks/PlatformPayment.java | 30 + .../RelayedAuthorisationData.java | 10 + .../model/transferwebhooks/Resource.java | 15 + .../transferwebhooks/ResourceReference.java | 15 + .../SELocalAccountIdentification.java | 15 + .../SGLocalAccountIdentification.java | 15 + .../TransactionEventViolation.java | 15 + .../TransactionRuleReference.java | 25 + .../TransactionRuleSource.java | 10 + .../TransactionRulesResult.java | 20 + .../model/transferwebhooks/TransferData.java | 120 ++- .../model/transferwebhooks/TransferEvent.java | 134 +-- .../TransferNotificationCounterParty.java | 243 +++++ .../TransferNotificationMerchantData.java | 349 +++++++ .../TransferNotificationRequest.java | 15 + .../TransferNotificationTransferTracking.java | 10 + .../TransferNotificationValidationFact.java | 10 + .../UKLocalAccountIdentification.java | 15 + .../USLocalAccountIdentification.java | 20 + .../com/adyen/service/BalanceControlApi.java | 6 +- .../java/com/adyen/service/BinLookupApi.java | 6 +- .../com/adyen/service/DataProtectionApi.java | 6 +- .../java/com/adyen/service/DisputesApi.java | 6 +- .../java/com/adyen/service/PaymentApi.java | 6 +- .../service/PosTerminalManagementApi.java | 6 +- .../java/com/adyen/service/RecurringApi.java | 6 +- .../com/adyen/service/StoredValueApi.java | 6 +- .../balanceplatform/AccountHoldersApi.java | 54 +- .../balanceplatform/BalanceAccountsApi.java | 236 ++--- .../PaymentInstrumentGroupsApi.java | 52 +- .../PaymentInstrumentsApi.java | 120 +-- .../service/balanceplatform/PlatformApi.java | 60 +- .../balanceplatform/TransactionRulesApi.java | 54 +- .../adyen/service/checkout/DonationsApi.java | 80 ++ .../service/checkout/ModificationsApi.java | 70 +- .../com/adyen/service/checkout/OrdersApi.java | 54 +- .../service/checkout/PaymentLinksApi.java | 54 +- .../adyen/service/checkout/PaymentsApi.java | 81 +- .../BusinessLinesApi.java | 54 +- .../HostedOnboardingApi.java | 64 +- .../LegalEntitiesApi.java | 144 +-- .../PciQuestionnairesApi.java | 52 +- .../TermsOfServiceApi.java | 108 +-- .../TransferInstrumentsApi.java | 54 +- .../management/AccountCompanyLevelApi.java | 66 +- .../management/AccountMerchantLevelApi.java | 64 +- .../management/AccountStoreLevelApi.java | 202 ++-- .../AllowedOriginsCompanyLevelApi.java | 66 +- .../AllowedOriginsMerchantLevelApi.java | 66 +- .../AndroidFilesCompanyLevelApi.java | 90 +- .../ApiCredentialsCompanyLevelApi.java | 102 +-- .../ApiCredentialsMerchantLevelApi.java | 102 +-- .../management/MyApiCredentialApi.java | 146 +-- .../PaymentMethodsMerchantLevelApi.java | 116 +-- .../PayoutSettingsMerchantLevelApi.java | 106 +-- .../SplitConfigurationMerchantLevelApi.java | 228 ++--- .../TerminalActionsCompanyLevelApi.java | 78 +- .../TerminalOrdersCompanyLevelApi.java | 326 +++---- .../TerminalOrdersMerchantLevelApi.java | 334 +++---- .../TerminalSettingsStoreLevelApi.java | 160 ++-- .../management/UsersCompanyLevelApi.java | 110 +-- .../management/UsersMerchantLevelApi.java | 110 +-- .../management/WebhooksCompanyLevelApi.java | 152 +-- .../management/WebhooksMerchantLevelApi.java | 160 ++-- .../service/transfers/TransactionsApi.java | 4 +- .../adyen/service/transfers/TransfersApi.java | 68 +- 1004 files changed, 34293 insertions(+), 2519 deletions(-) create mode 100644 src/main/java/com/adyen/model/checkout/ApplePayDonations.java create mode 100644 src/main/java/com/adyen/model/checkout/CardDonations.java create mode 100644 src/main/java/com/adyen/model/checkout/GooglePayDonations.java create mode 100644 src/main/java/com/adyen/model/checkout/IdealDonations.java create mode 100644 src/main/java/com/adyen/model/checkout/PayWithGoogleDonations.java create mode 100644 src/main/java/com/adyen/model/management/TapToPay.java create mode 100644 src/main/java/com/adyen/model/transferwebhooks/TransferNotificationCounterParty.java create mode 100644 src/main/java/com/adyen/model/transferwebhooks/TransferNotificationMerchantData.java create mode 100644 src/main/java/com/adyen/service/checkout/DonationsApi.java diff --git a/src/main/java/com/adyen/model/acswebhooks/Amount.java b/src/main/java/com/adyen/model/acswebhooks/Amount.java index e1c20fcdf..70a60115f 100644 --- a/src/main/java/com/adyen/model/acswebhooks/Amount.java +++ b/src/main/java/com/adyen/model/acswebhooks/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/acswebhooks/AuthenticationInfo.java b/src/main/java/com/adyen/model/acswebhooks/AuthenticationInfo.java index 491349535..16083d714 100644 --- a/src/main/java/com/adyen/model/acswebhooks/AuthenticationInfo.java +++ b/src/main/java/com/adyen/model/acswebhooks/AuthenticationInfo.java @@ -462,6 +462,11 @@ public String getAcsTransId() { } + /** + * Universally unique transaction identifier assigned by the Access Control Server (ACS) to identify a single transaction. + * + * @param acsTransId + */ @JsonProperty(JSON_PROPERTY_ACS_TRANS_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsTransId(String acsTransId) { @@ -487,6 +492,11 @@ public ChallengeInfo getChallenge() { } + /** + * challenge + * + * @param challenge + */ @JsonProperty(JSON_PROPERTY_CHALLENGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallenge(ChallengeInfo challenge) { @@ -512,6 +522,11 @@ public ChallengeIndicatorEnum getChallengeIndicator() { } + /** + * 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) + * + * @param challengeIndicator + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeIndicator(ChallengeIndicatorEnum challengeIndicator) { @@ -537,6 +552,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * 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**. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -562,6 +582,11 @@ public DeviceChannelEnum getDeviceChannel() { } + /** + * 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) + * + * @param deviceChannel + */ @JsonProperty(JSON_PROPERTY_DEVICE_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceChannel(DeviceChannelEnum deviceChannel) { @@ -587,6 +612,11 @@ public String getDsTransID() { } + /** + * Universally unique transaction identifier assigned by the DS (card scheme) to identify a single transaction. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -612,6 +642,11 @@ public ExemptionIndicatorEnum getExemptionIndicator() { } + /** + * 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** + * + * @param exemptionIndicator + */ @JsonProperty(JSON_PROPERTY_EXEMPTION_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExemptionIndicator(ExemptionIndicatorEnum exemptionIndicator) { @@ -637,6 +672,11 @@ public Boolean getInPSD2Scope() { } + /** + * Indicates if the purchase was in the PSD2 scope. + * + * @param inPSD2Scope + */ @JsonProperty(JSON_PROPERTY_IN_P_S_D2_SCOPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInPSD2Scope(Boolean inPSD2Scope) { @@ -662,6 +702,11 @@ public MessageCategoryEnum getMessageCategory() { } + /** + * Identifies the category of the message for a specific use case. Possible values: * **payment** * **nonPayment** + * + * @param messageCategory + */ @JsonProperty(JSON_PROPERTY_MESSAGE_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageCategory(MessageCategoryEnum messageCategory) { @@ -687,6 +732,11 @@ public String getMessageVersion() { } + /** + * The `messageVersion` value as defined in the 3D Secure 2 specification. + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -712,6 +762,11 @@ public Integer getRiskScore() { } + /** + * Risk score calculated from the transaction rules. + * + * @param riskScore + */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskScore(Integer riskScore) { @@ -737,6 +792,11 @@ public String getThreeDSServerTransID() { } + /** + * The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. + * + * @param threeDSServerTransID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSServerTransID(String threeDSServerTransID) { @@ -762,6 +822,11 @@ public TransStatusEnum getTransStatus() { } + /** + * 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. + * + * @param transStatus + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatus(TransStatusEnum transStatus) { @@ -787,6 +852,11 @@ public TransStatusReasonEnum getTransStatusReason() { } + /** + * 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). + * + * @param transStatusReason + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatusReason(TransStatusReasonEnum transStatusReason) { @@ -812,6 +882,11 @@ public TypeEnum getType() { } + /** + * The type of authentication performed. Possible values: * **frictionless** * **challenge** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationData.java b/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationData.java index 4ec2ae3e6..107c727c8 100644 --- a/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationData.java +++ b/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationData.java @@ -118,6 +118,11 @@ public AuthenticationInfo getAuthentication() { } + /** + * authentication + * + * @param authentication + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthentication(AuthenticationInfo authentication) { @@ -143,6 +148,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -168,6 +178,11 @@ public String getId() { } + /** + * Unique identifier of the authentication. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -193,6 +208,11 @@ public String getPaymentInstrumentId() { } + /** + * Unique identifier of the payment instrument that was used for the authentication. + * + * @param paymentInstrumentId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentId(String paymentInstrumentId) { @@ -218,6 +238,11 @@ public PurchaseInfo getPurchase() { } + /** + * purchase + * + * @param purchase + */ @JsonProperty(JSON_PROPERTY_PURCHASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPurchase(PurchaseInfo purchase) { @@ -243,6 +268,11 @@ public StatusEnum getStatus() { } + /** + * Outcome of the authentication. Allowed values: * authenticated * rejected * error + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationRequest.java b/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationRequest.java index 039d000a7..eec1f4a9f 100644 --- a/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationRequest.java +++ b/src/main/java/com/adyen/model/acswebhooks/AuthenticationNotificationRequest.java @@ -101,6 +101,11 @@ public AuthenticationNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(AuthenticationNotificationData data) { @@ -126,6 +131,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -151,6 +161,11 @@ public TypeEnum getType() { } + /** + * Type of notification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/acswebhooks/BalancePlatformNotificationResponse.java b/src/main/java/com/adyen/model/acswebhooks/BalancePlatformNotificationResponse.java index 98b24cd6f..36085cabf 100644 --- a/src/main/java/com/adyen/model/acswebhooks/BalancePlatformNotificationResponse.java +++ b/src/main/java/com/adyen/model/acswebhooks/BalancePlatformNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/acswebhooks/ChallengeInfo.java b/src/main/java/com/adyen/model/acswebhooks/ChallengeInfo.java index 2f50ce836..1bbdacec4 100644 --- a/src/main/java/com/adyen/model/acswebhooks/ChallengeInfo.java +++ b/src/main/java/com/adyen/model/acswebhooks/ChallengeInfo.java @@ -160,6 +160,11 @@ public ChallengeCancelEnum getChallengeCancel() { } + /** + * 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). + * + * @param challengeCancel + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_CANCEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeCancel(ChallengeCancelEnum challengeCancel) { @@ -185,6 +190,11 @@ public FlowEnum getFlow() { } + /** + * The flow used in the challenge. Possible values: * **OTP_SMS**: one-time password (OTP) flow * **OOB**: out-of-band (OOB) flow + * + * @param flow + */ @JsonProperty(JSON_PROPERTY_FLOW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFlow(FlowEnum flow) { @@ -210,6 +220,11 @@ public OffsetDateTime getLastInteraction() { } + /** + * The last time of interaction with the challenge. + * + * @param lastInteraction + */ @JsonProperty(JSON_PROPERTY_LAST_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastInteraction(OffsetDateTime lastInteraction) { @@ -235,6 +250,11 @@ public String getPhoneNumber() { } + /** + * The last four digits of the phone number used in the challenge. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -260,6 +280,11 @@ public Integer getResends() { } + /** + * The number of times the one-time password (OTP) was resent during the challenge. + * + * @param resends + */ @JsonProperty(JSON_PROPERTY_RESENDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResends(Integer resends) { @@ -285,6 +310,11 @@ public Integer getRetries() { } + /** + * The number of retries used in the challenge. + * + * @param retries + */ @JsonProperty(JSON_PROPERTY_RETRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetries(Integer retries) { diff --git a/src/main/java/com/adyen/model/acswebhooks/PurchaseInfo.java b/src/main/java/com/adyen/model/acswebhooks/PurchaseInfo.java index 5cc63b20d..67f06066c 100644 --- a/src/main/java/com/adyen/model/acswebhooks/PurchaseInfo.java +++ b/src/main/java/com/adyen/model/acswebhooks/PurchaseInfo.java @@ -68,6 +68,11 @@ public String getDate() { } + /** + * Date of the purchase. + * + * @param date + */ @JsonProperty(JSON_PROPERTY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDate(String date) { @@ -93,6 +98,11 @@ public String getMerchantName() { } + /** + * Name of the merchant. + * + * @param merchantName + */ @JsonProperty(JSON_PROPERTY_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantName(String merchantName) { @@ -118,6 +128,11 @@ public Amount getOriginalAmount() { } + /** + * originalAmount + * + * @param originalAmount + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalAmount(Amount originalAmount) { diff --git a/src/main/java/com/adyen/model/acswebhooks/Resource.java b/src/main/java/com/adyen/model/acswebhooks/Resource.java index 8935640df..f0bcffdd8 100644 --- a/src/main/java/com/adyen/model/acswebhooks/Resource.java +++ b/src/main/java/com/adyen/model/acswebhooks/Resource.java @@ -68,6 +68,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -93,6 +98,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/balancecontrol/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/balancecontrol/AbstractOpenApiSchema.java index 483c41c41..d9826444e 100644 --- a/src/main/java/com/adyen/model/balancecontrol/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/balancecontrol/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Adyen Balance Control API - * The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. ## Authentication To connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key: ``` curl -H \"X-API-Key: Your_API_key\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Balance Control API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer ``` * * The version of the OpenAPI document: 1 * diff --git a/src/main/java/com/adyen/model/balancecontrol/Amount.java b/src/main/java/com/adyen/model/balancecontrol/Amount.java index 95496c006..ec0a1399a 100644 --- a/src/main/java/com/adyen/model/balancecontrol/Amount.java +++ b/src/main/java/com/adyen/model/balancecontrol/Amount.java @@ -1,6 +1,5 @@ /* * Adyen Balance Control API - * The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. ## Authentication To connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key: ``` curl -H \"X-API-Key: Your_API_key\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Balance Control API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer ``` * * The version of the OpenAPI document: 1 * @@ -64,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -89,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/balancecontrol/BalanceTransferRequest.java b/src/main/java/com/adyen/model/balancecontrol/BalanceTransferRequest.java index b72fc4896..af4732408 100644 --- a/src/main/java/com/adyen/model/balancecontrol/BalanceTransferRequest.java +++ b/src/main/java/com/adyen/model/balancecontrol/BalanceTransferRequest.java @@ -1,6 +1,5 @@ /* * Adyen Balance Control API - * The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. ## Authentication To connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key: ``` curl -H \"X-API-Key: Your_API_key\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Balance Control API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer ``` * * The version of the OpenAPI document: 1 * @@ -124,6 +123,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -149,6 +153,11 @@ public String getDescription() { } + /** + * 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. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -174,6 +183,11 @@ public String getFromMerchant() { } + /** + * The unique identifier of the source merchant account from which funds are deducted. + * + * @param fromMerchant + */ @JsonProperty(JSON_PROPERTY_FROM_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFromMerchant(String fromMerchant) { @@ -199,6 +213,11 @@ public String getReference() { } + /** + * A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -224,6 +243,11 @@ public String getToMerchant() { } + /** + * The unique identifier of the destination merchant account from which funds are transferred. + * + * @param toMerchant + */ @JsonProperty(JSON_PROPERTY_TO_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToMerchant(String toMerchant) { @@ -249,6 +273,11 @@ public TypeEnum getType() { } + /** + * The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balancecontrol/BalanceTransferResponse.java b/src/main/java/com/adyen/model/balancecontrol/BalanceTransferResponse.java index 741fd3ccf..0fc21837d 100644 --- a/src/main/java/com/adyen/model/balancecontrol/BalanceTransferResponse.java +++ b/src/main/java/com/adyen/model/balancecontrol/BalanceTransferResponse.java @@ -1,6 +1,5 @@ /* * Adyen Balance Control API - * The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. ## Authentication To connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key: ``` curl -H \"X-API-Key: Your_API_key\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Balance Control API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer ``` * * The version of the OpenAPI document: 1 * @@ -176,6 +175,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -201,6 +205,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * The date when the balance transfer was requested. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -226,6 +235,11 @@ public String getDescription() { } + /** + * 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. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -251,6 +265,11 @@ public String getFromMerchant() { } + /** + * The unique identifier of the source merchant account from which funds are deducted. + * + * @param fromMerchant + */ @JsonProperty(JSON_PROPERTY_FROM_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFromMerchant(String fromMerchant) { @@ -276,6 +295,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the balance transfer. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -301,6 +325,11 @@ public String getReference() { } + /** + * A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -326,6 +355,11 @@ public StatusEnum getStatus() { } + /** + * The status of the balance transfer. Possible values: **transferred**, **failed**, **error**, and **notEnoughBalance**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -351,6 +385,11 @@ public String getToMerchant() { } + /** + * The unique identifier of the destination merchant account from which funds are transferred. + * + * @param toMerchant + */ @JsonProperty(JSON_PROPERTY_TO_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToMerchant(String toMerchant) { @@ -376,6 +415,11 @@ public TypeEnum getType() { } + /** + * The type of balance transfer. Possible values: **tax**, **fee**, **terminalSale**, **credit**, **debit**, and **adjustment**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AULocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/AULocalAccountIdentification.java index 3416744a7..014242827 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/AULocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBsbCode() { } + /** + * The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. + * + * @param bsbCode + */ @JsonProperty(JSON_PROPERTY_BSB_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBsbCode(String bsbCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **auLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AccountHolder.java b/src/main/java/com/adyen/model/balanceplatform/AccountHolder.java index b3ab69e21..b1902c3af 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AccountHolder.java +++ b/src/main/java/com/adyen/model/balanceplatform/AccountHolder.java @@ -153,6 +153,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -186,6 +191,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -211,6 +221,11 @@ public ContactDetails getContactDetails() { } + /** + * contactDetails + * + * @param contactDetails + */ @JsonProperty(JSON_PROPERTY_CONTACT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContactDetails(ContactDetails contactDetails) { @@ -236,6 +251,11 @@ public String getDescription() { } + /** + * Your description for the account holder, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -261,6 +281,11 @@ public String getId() { } + /** + * The unique identifier of the account holder. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -286,6 +311,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -319,6 +349,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -344,6 +379,11 @@ public String getMigratedAccountHolderCode() { } + /** + * The unique identifier of the migrated account holder in the classic integration. + * + * @param migratedAccountHolderCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountHolderCode(String migratedAccountHolderCode) { @@ -369,6 +409,11 @@ public String getPrimaryBalanceAccount() { } + /** + * The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request. + * + * @param primaryBalanceAccount + */ @JsonProperty(JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryBalanceAccount(String primaryBalanceAccount) { @@ -394,6 +439,11 @@ public String getReference() { } + /** + * Your reference for the account holder, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -419,6 +469,11 @@ public StatusEnum getStatus() { } + /** + * The status of the account holder. Possible values: * **active**: The account holder is active. This is the default status when creating an account holder. * **inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. * **closed**: The account holder is permanently deactivated by you. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -444,6 +499,11 @@ public String getTimeZone() { } + /** + * The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { @@ -477,6 +537,11 @@ public List getVerificationDeadlines() { } + /** + * List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved. + * + * @param verificationDeadlines + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationDeadlines(List verificationDeadlines) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AccountHolderCapability.java b/src/main/java/com/adyen/model/balanceplatform/AccountHolderCapability.java index c83ac541d..681ad5fe5 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AccountHolderCapability.java +++ b/src/main/java/com/adyen/model/balanceplatform/AccountHolderCapability.java @@ -217,6 +217,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -242,6 +247,11 @@ public AllowedLevelEnum getAllowedLevel() { } + /** + * The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param allowedLevel + */ @JsonProperty(JSON_PROPERTY_ALLOWED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedLevel(AllowedLevelEnum allowedLevel) { @@ -267,6 +277,11 @@ public CapabilitySettings getAllowedSettings() { } + /** + * allowedSettings + * + * @param allowedSettings + */ @JsonProperty(JSON_PROPERTY_ALLOWED_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedSettings(CapabilitySettings allowedSettings) { @@ -292,6 +307,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -325,6 +345,11 @@ public List getProblems() { } + /** + * Contains verification errors and the actions that you can take to resolve them. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { @@ -350,6 +375,11 @@ public Boolean getRequested() { } + /** + * Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -375,6 +405,11 @@ public RequestedLevelEnum getRequestedLevel() { } + /** + * The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param requestedLevel + */ @JsonProperty(JSON_PROPERTY_REQUESTED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedLevel(RequestedLevelEnum requestedLevel) { @@ -400,6 +435,11 @@ public CapabilitySettings getRequestedSettings() { } + /** + * requestedSettings + * + * @param requestedSettings + */ @JsonProperty(JSON_PROPERTY_REQUESTED_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedSettings(CapabilitySettings requestedSettings) { @@ -433,6 +473,11 @@ public List getTransferInstruments() { } + /** + * Contains the status of the transfer instruments associated with this capability. + * + * @param transferInstruments + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstruments(List transferInstruments) { @@ -458,6 +503,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * The status of the verification checks for the capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AccountHolderInfo.java b/src/main/java/com/adyen/model/balanceplatform/AccountHolderInfo.java index e26796af7..a01f532f7 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AccountHolderInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/AccountHolderInfo.java @@ -96,6 +96,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -129,6 +134,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -154,6 +164,11 @@ public ContactDetails getContactDetails() { } + /** + * contactDetails + * + * @param contactDetails + */ @JsonProperty(JSON_PROPERTY_CONTACT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContactDetails(ContactDetails contactDetails) { @@ -179,6 +194,11 @@ public String getDescription() { } + /** + * Your description for the account holder, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -204,6 +224,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -237,6 +262,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -262,6 +292,11 @@ public String getMigratedAccountHolderCode() { } + /** + * The unique identifier of the migrated account holder in the classic integration. + * + * @param migratedAccountHolderCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountHolderCode(String migratedAccountHolderCode) { @@ -287,6 +322,11 @@ public String getReference() { } + /** + * Your reference for the account holder, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -312,6 +352,11 @@ public String getTimeZone() { } + /** + * The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AccountHolderUpdateRequest.java b/src/main/java/com/adyen/model/balanceplatform/AccountHolderUpdateRequest.java index 2f564d3b4..a25c1329d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AccountHolderUpdateRequest.java +++ b/src/main/java/com/adyen/model/balanceplatform/AccountHolderUpdateRequest.java @@ -145,6 +145,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -178,6 +183,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -203,6 +213,11 @@ public ContactDetails getContactDetails() { } + /** + * contactDetails + * + * @param contactDetails + */ @JsonProperty(JSON_PROPERTY_CONTACT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContactDetails(ContactDetails contactDetails) { @@ -228,6 +243,11 @@ public String getDescription() { } + /** + * Your description for the account holder, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -261,6 +281,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -286,6 +311,11 @@ public String getMigratedAccountHolderCode() { } + /** + * The unique identifier of the migrated account holder in the classic integration. + * + * @param migratedAccountHolderCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountHolderCode(String migratedAccountHolderCode) { @@ -311,6 +341,11 @@ public String getPrimaryBalanceAccount() { } + /** + * The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request. + * + * @param primaryBalanceAccount + */ @JsonProperty(JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryBalanceAccount(String primaryBalanceAccount) { @@ -336,6 +371,11 @@ public String getReference() { } + /** + * Your reference for the account holder, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -361,6 +401,11 @@ public StatusEnum getStatus() { } + /** + * The status of the account holder. Possible values: * **active**: The account holder is active. This is the default status when creating an account holder. * **inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. * **suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. * **closed**: The account holder is permanently deactivated by you. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -386,6 +431,11 @@ public String getTimeZone() { } + /** + * The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { @@ -419,6 +469,11 @@ public List getVerificationDeadlines() { } + /** + * List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved. + * + * @param verificationDeadlines + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationDeadlines(List verificationDeadlines) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AccountSupportingEntityCapability.java b/src/main/java/com/adyen/model/balanceplatform/AccountSupportingEntityCapability.java index bd4bca4f0..c4c779696 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AccountSupportingEntityCapability.java +++ b/src/main/java/com/adyen/model/balanceplatform/AccountSupportingEntityCapability.java @@ -200,6 +200,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the supporting entity capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -225,6 +230,11 @@ public AllowedLevelEnum getAllowedLevel() { } + /** + * The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param allowedLevel + */ @JsonProperty(JSON_PROPERTY_ALLOWED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedLevel(AllowedLevelEnum allowedLevel) { @@ -250,6 +260,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -275,6 +290,11 @@ public String getId() { } + /** + * The ID of the supporting entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -300,6 +320,11 @@ public Boolean getRequested() { } + /** + * Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -325,6 +350,11 @@ public RequestedLevelEnum getRequestedLevel() { } + /** + * The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param requestedLevel + */ @JsonProperty(JSON_PROPERTY_REQUESTED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedLevel(RequestedLevelEnum requestedLevel) { @@ -350,6 +380,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * The status of the verification checks for the supporting entity capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { diff --git a/src/main/java/com/adyen/model/balanceplatform/ActiveNetworkTokensRestriction.java b/src/main/java/com/adyen/model/balanceplatform/ActiveNetworkTokensRestriction.java index 0599493a0..a31c5d9ca 100644 --- a/src/main/java/com/adyen/model/balanceplatform/ActiveNetworkTokensRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/ActiveNetworkTokensRestriction.java @@ -63,6 +63,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -88,6 +93,11 @@ public Integer getValue() { } + /** + * The number of tokens. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Integer value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AdditionalBankIdentification.java b/src/main/java/com/adyen/model/balanceplatform/AdditionalBankIdentification.java index af8ec80fa..0604f31c8 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AdditionalBankIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/AdditionalBankIdentification.java @@ -98,6 +98,11 @@ public String getCode() { } + /** + * The value of the additional bank identification. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * The type of additional bank identification, depending on the country. Possible values: * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Address.java b/src/main/java/com/adyen/model/balanceplatform/Address.java index 9b67fb216..b7e0b6f1d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Address.java +++ b/src/main/java/com/adyen/model/balanceplatform/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -154,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -179,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -204,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AddressRequirement.java b/src/main/java/com/adyen/model/balanceplatform/AddressRequirement.java index f343d8b9d..83c128505 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AddressRequirement.java +++ b/src/main/java/com/adyen/model/balanceplatform/AddressRequirement.java @@ -143,6 +143,11 @@ public String getDescription() { } + /** + * Specifies the required address related fields for a particular route. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -176,6 +181,11 @@ public List getRequiredAddressFields() { } + /** + * List of address fields. + * + * @param requiredAddressFields + */ @JsonProperty(JSON_PROPERTY_REQUIRED_ADDRESS_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequiredAddressFields(List requiredAddressFields) { @@ -201,6 +211,11 @@ public TypeEnum getType() { } + /** + * **addressRequirement** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Amount.java b/src/main/java/com/adyen/model/balanceplatform/Amount.java index 9bf8fef2c..a58dddbbd 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Amount.java +++ b/src/main/java/com/adyen/model/balanceplatform/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/AmountMinMaxRequirement.java b/src/main/java/com/adyen/model/balanceplatform/AmountMinMaxRequirement.java index 22bd34be1..84022fe62 100644 --- a/src/main/java/com/adyen/model/balanceplatform/AmountMinMaxRequirement.java +++ b/src/main/java/com/adyen/model/balanceplatform/AmountMinMaxRequirement.java @@ -104,6 +104,11 @@ public String getDescription() { } + /** + * Specifies the eligible amounts for a particular route. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -129,6 +134,11 @@ public Long getMax() { } + /** + * Maximum amount. + * + * @param max + */ @JsonProperty(JSON_PROPERTY_MAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMax(Long max) { @@ -154,6 +164,11 @@ public Long getMin() { } + /** + * Minimum amount. + * + * @param min + */ @JsonProperty(JSON_PROPERTY_MIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMin(Long min) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **amountMinMaxRequirement** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Authentication.java b/src/main/java/com/adyen/model/balanceplatform/Authentication.java index b676b858c..da54f4ecb 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Authentication.java +++ b/src/main/java/com/adyen/model/balanceplatform/Authentication.java @@ -68,6 +68,11 @@ public String getEmail() { } + /** + * The email address where the one-time password (OTP) is sent. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -93,6 +98,11 @@ public String getPassword() { } + /** + * The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters. * Characters between **a-z**, **A-Z**, and **0-9** * Special characters: **äöüßÄÖÜ+-*_/ç%()=?!~#'\",;:$&àùòâôûáúó** + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -118,6 +128,11 @@ public Phone getPhone() { } + /** + * phone + * + * @param phone + */ @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhone(Phone phone) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BRLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/BRLocalAccountIdentification.java index 623a64b37..a16de4c59 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BRLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/BRLocalAccountIdentification.java @@ -104,6 +104,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -129,6 +134,11 @@ public String getBankCode() { } + /** + * The 3-digit bank code, with leading zeros. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -154,6 +164,11 @@ public String getBranchNumber() { } + /** + * The bank account branch number, without separators or whitespace. + * + * @param branchNumber + */ @JsonProperty(JSON_PROPERTY_BRANCH_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBranchNumber(String branchNumber) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **brLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Balance.java b/src/main/java/com/adyen/model/balanceplatform/Balance.java index 913d4b83d..fb6a19988 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Balance.java +++ b/src/main/java/com/adyen/model/balanceplatform/Balance.java @@ -75,6 +75,11 @@ public Long getAvailable() { } + /** + * The remaining amount available for spending. + * + * @param available + */ @JsonProperty(JSON_PROPERTY_AVAILABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvailable(Long available) { @@ -100,6 +105,11 @@ public Long getBalance() { } + /** + * The total amount in the balance. + * + * @param balance + */ @JsonProperty(JSON_PROPERTY_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalance(Long balance) { @@ -125,6 +135,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -150,6 +165,11 @@ public Long getPending() { } + /** + * The amount pending to be paid out but not yet available in the balance. + * + * @param pending + */ @JsonProperty(JSON_PROPERTY_PENDING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPending(Long pending) { @@ -175,6 +195,11 @@ public Long getReserved() { } + /** + * The amount reserved for payments that have been authorised, but have not been captured yet. + * + * @param reserved + */ @JsonProperty(JSON_PROPERTY_RESERVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReserved(Long reserved) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BalanceAccount.java b/src/main/java/com/adyen/model/balanceplatform/BalanceAccount.java index 3fc0b50e0..ec4663ff3 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BalanceAccount.java +++ b/src/main/java/com/adyen/model/balanceplatform/BalanceAccount.java @@ -144,6 +144,11 @@ public String getAccountHolderId() { } + /** + * The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -177,6 +182,11 @@ public List getBalances() { } + /** + * List of balances with the amount and currency. + * + * @param balances + */ @JsonProperty(JSON_PROPERTY_BALANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalances(List balances) { @@ -202,6 +212,11 @@ public String getDefaultCurrencyCode() { } + /** + * The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency. + * + * @param defaultCurrencyCode + */ @JsonProperty(JSON_PROPERTY_DEFAULT_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultCurrencyCode(String defaultCurrencyCode) { @@ -227,6 +242,11 @@ public String getDescription() { } + /** + * A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -252,6 +272,11 @@ public String getId() { } + /** + * The unique identifier of the balance account. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -285,6 +310,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -310,6 +340,11 @@ public String getMigratedAccountCode() { } + /** + * The unique identifier of the account of the migrated account holder in the classic integration. + * + * @param migratedAccountCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountCode(String migratedAccountCode) { @@ -335,6 +370,11 @@ public PlatformPaymentConfiguration getPlatformPaymentConfiguration() { } + /** + * platformPaymentConfiguration + * + * @param platformPaymentConfiguration + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration) { @@ -360,6 +400,11 @@ public String getReference() { } + /** + * Your reference for the balance account, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -385,6 +430,11 @@ public StatusEnum getStatus() { } + /** + * The status of the balance account, set to **active** by default. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -410,6 +460,11 @@ public String getTimeZone() { } + /** + * The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BalanceAccountBase.java b/src/main/java/com/adyen/model/balanceplatform/BalanceAccountBase.java index fee989743..4af313de1 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BalanceAccountBase.java +++ b/src/main/java/com/adyen/model/balanceplatform/BalanceAccountBase.java @@ -138,6 +138,11 @@ public String getAccountHolderId() { } + /** + * The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -163,6 +168,11 @@ public String getDefaultCurrencyCode() { } + /** + * The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency. + * + * @param defaultCurrencyCode + */ @JsonProperty(JSON_PROPERTY_DEFAULT_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultCurrencyCode(String defaultCurrencyCode) { @@ -188,6 +198,11 @@ public String getDescription() { } + /** + * A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -213,6 +228,11 @@ public String getId() { } + /** + * The unique identifier of the balance account. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -246,6 +266,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -271,6 +296,11 @@ public String getMigratedAccountCode() { } + /** + * The unique identifier of the account of the migrated account holder in the classic integration. + * + * @param migratedAccountCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountCode(String migratedAccountCode) { @@ -296,6 +326,11 @@ public PlatformPaymentConfiguration getPlatformPaymentConfiguration() { } + /** + * platformPaymentConfiguration + * + * @param platformPaymentConfiguration + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration) { @@ -321,6 +356,11 @@ public String getReference() { } + /** + * Your reference for the balance account, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -346,6 +386,11 @@ public StatusEnum getStatus() { } + /** + * The status of the balance account, set to **active** by default. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -371,6 +416,11 @@ public String getTimeZone() { } + /** + * The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BalanceAccountInfo.java b/src/main/java/com/adyen/model/balanceplatform/BalanceAccountInfo.java index 021d7f8ad..c18f87442 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BalanceAccountInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/BalanceAccountInfo.java @@ -91,6 +91,11 @@ public String getAccountHolderId() { } + /** + * The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -116,6 +121,11 @@ public String getDefaultCurrencyCode() { } + /** + * The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency. + * + * @param defaultCurrencyCode + */ @JsonProperty(JSON_PROPERTY_DEFAULT_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultCurrencyCode(String defaultCurrencyCode) { @@ -141,6 +151,11 @@ public String getDescription() { } + /** + * A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -174,6 +189,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -199,6 +219,11 @@ public String getMigratedAccountCode() { } + /** + * The unique identifier of the account of the migrated account holder in the classic integration. + * + * @param migratedAccountCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountCode(String migratedAccountCode) { @@ -224,6 +249,11 @@ public PlatformPaymentConfiguration getPlatformPaymentConfiguration() { } + /** + * platformPaymentConfiguration + * + * @param platformPaymentConfiguration + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration) { @@ -249,6 +279,11 @@ public String getReference() { } + /** + * Your reference for the balance account, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -274,6 +309,11 @@ public String getTimeZone() { } + /** + * The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BalanceAccountUpdateRequest.java b/src/main/java/com/adyen/model/balanceplatform/BalanceAccountUpdateRequest.java index cfb4ae376..df6a0c0de 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BalanceAccountUpdateRequest.java +++ b/src/main/java/com/adyen/model/balanceplatform/BalanceAccountUpdateRequest.java @@ -126,6 +126,11 @@ public String getAccountHolderId() { } + /** + * The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -151,6 +156,11 @@ public String getDescription() { } + /** + * A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -184,6 +194,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -209,6 +224,11 @@ public PlatformPaymentConfiguration getPlatformPaymentConfiguration() { } + /** + * platformPaymentConfiguration + * + * @param platformPaymentConfiguration + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration) { @@ -234,6 +254,11 @@ public String getReference() { } + /** + * Your reference to the balance account, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -259,6 +284,11 @@ public StatusEnum getStatus() { } + /** + * The status of the balance account. Payment instruments linked to the balance account can only be used if the balance account status is **active**. Possible values: **active**, **inactive**, **closed**, **suspended**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -284,6 +314,11 @@ public String getTimeZone() { } + /** + * The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BalancePlatform.java b/src/main/java/com/adyen/model/balanceplatform/BalancePlatform.java index 12d2ef271..98e660291 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BalancePlatform.java +++ b/src/main/java/com/adyen/model/balanceplatform/BalancePlatform.java @@ -67,6 +67,11 @@ public String getDescription() { } + /** + * Your description of the balance platform, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -92,6 +97,11 @@ public String getId() { } + /** + * The unique identifier of the balance platform. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -117,6 +127,11 @@ public String getStatus() { } + /** + * The status of the balance platform. Possible values: **Active**, **Inactive**, **Closed**, **Suspended**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BalanceSweepConfigurationsResponse.java b/src/main/java/com/adyen/model/balanceplatform/BalanceSweepConfigurationsResponse.java index 32ae29edb..a54d4b19f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BalanceSweepConfigurationsResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/BalanceSweepConfigurationsResponse.java @@ -70,6 +70,11 @@ public Boolean getHasNext() { } + /** + * Indicates whether there are more items on the next page. + * + * @param hasNext + */ @JsonProperty(JSON_PROPERTY_HAS_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasNext(Boolean hasNext) { @@ -95,6 +100,11 @@ public Boolean getHasPrevious() { } + /** + * Indicates whether there are more items on the previous page. + * + * @param hasPrevious + */ @JsonProperty(JSON_PROPERTY_HAS_PREVIOUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasPrevious(Boolean hasPrevious) { @@ -125,6 +135,11 @@ public List getSweeps() { } + /** + * List of sweeps associated with the balance account. + * + * @param sweeps + */ @JsonProperty(JSON_PROPERTY_SWEEPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSweeps(List sweeps) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BankAccount.java b/src/main/java/com/adyen/model/balanceplatform/BankAccount.java index 9e9fa31a1..1ecd6e5a3 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BankAccount.java +++ b/src/main/java/com/adyen/model/balanceplatform/BankAccount.java @@ -60,6 +60,11 @@ public BankAccountAccountIdentification getAccountIdentification() { } + /** + * accountIdentification + * + * @param accountIdentification + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountIdentification(BankAccountAccountIdentification accountIdentification) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationTypeRequirement.java b/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationTypeRequirement.java index 3b187daf5..edb487e0d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationTypeRequirement.java +++ b/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationTypeRequirement.java @@ -175,6 +175,11 @@ public List getBankAccountIdentificationType } + /** + * List of bank account identification types: eg.; [iban , numberAndBic] + * + * @param bankAccountIdentificationTypes + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_IDENTIFICATION_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountIdentificationTypes(List bankAccountIdentificationTypes) { @@ -200,6 +205,11 @@ public String getDescription() { } + /** + * Specifies the bank account details for a particular route per required field in this object depending on the country of the bank account and the currency of the transfer. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -225,6 +235,11 @@ public TypeEnum getType() { } + /** + * **bankAccountIdentificationTypeRequirement** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationValidationRequest.java b/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationValidationRequest.java index da9bdedb4..6f4fbf59e 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationValidationRequest.java +++ b/src/main/java/com/adyen/model/balanceplatform/BankAccountIdentificationValidationRequest.java @@ -60,6 +60,11 @@ public BankAccountIdentificationValidationRequestAccountIdentification getAccoun } + /** + * accountIdentification + * + * @param accountIdentification + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountIdentification(BankAccountIdentificationValidationRequestAccountIdentification accountIdentification) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BankIdentification.java b/src/main/java/com/adyen/model/balanceplatform/BankIdentification.java index bb3af4fc6..7c37ef5e5 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BankIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/BankIdentification.java @@ -102,6 +102,11 @@ public String getCountry() { } + /** + * country + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -127,6 +132,11 @@ public String getIdentification() { } + /** + * identification + * + * @param identification + */ @JsonProperty(JSON_PROPERTY_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentification(String identification) { @@ -152,6 +162,11 @@ public IdentificationTypeEnum getIdentificationType() { } + /** + * identificationType + * + * @param identificationType + */ @JsonProperty(JSON_PROPERTY_IDENTIFICATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentificationType(IdentificationTypeEnum identificationType) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BrandVariantsRestriction.java b/src/main/java/com/adyen/model/balanceplatform/BrandVariantsRestriction.java index 58a749501..5387c4f21 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BrandVariantsRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/BrandVariantsRestriction.java @@ -65,6 +65,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -98,6 +103,11 @@ public List getValue() { } + /** + * List of card brand variants. Possible values: - **mc**, **mccredit**, **mccommercialcredit_b2b**, **mcdebit**, **mcbusinessdebit**, **mcbusinessworlddebit**, **mcprepaid**, **mcmaestro** - **visa**, **visacredit**, **visadebit**, **visaprepaid**. You can specify a rule for a generic variant. For example, to create a rule for all Mastercard payment instruments, use **mc**. The rule is applied to all payment instruments under **mc**, such as **mcbusinessdebit** and **mcdebit**. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/BulkAddress.java b/src/main/java/com/adyen/model/balanceplatform/BulkAddress.java index 261e6cf85..012df1c1f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/BulkAddress.java +++ b/src/main/java/com/adyen/model/balanceplatform/BulkAddress.java @@ -91,6 +91,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -116,6 +121,11 @@ public String getCompany() { } + /** + * The name of the company. + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(String company) { @@ -141,6 +151,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -166,6 +181,11 @@ public String getEmail() { } + /** + * The email address. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -191,6 +211,11 @@ public String getHouseNumberOrName() { } + /** + * The house number or name. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -216,6 +241,11 @@ public String getMobile() { } + /** + * The full telephone number. + * + * @param mobile + */ @JsonProperty(JSON_PROPERTY_MOBILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMobile(String mobile) { @@ -241,6 +271,11 @@ public String getPostalCode() { } + /** + * The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -266,6 +301,11 @@ public String getStateOrProvince() { } + /** + * The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -291,6 +331,11 @@ public String getStreet() { } + /** + * The streetname of the house. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CALocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/CALocalAccountIdentification.java index 9175e5ece..3da2f4960 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CALocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/CALocalAccountIdentification.java @@ -143,6 +143,11 @@ public String getAccountNumber() { } + /** + * The 5- to 12-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -168,6 +173,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -193,6 +203,11 @@ public String getInstitutionNumber() { } + /** + * The 3-digit institution number, without separators or whitespace. + * + * @param institutionNumber + */ @JsonProperty(JSON_PROPERTY_INSTITUTION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstitutionNumber(String institutionNumber) { @@ -218,6 +233,11 @@ public String getTransitNumber() { } + /** + * The 5-digit transit number, without separators or whitespace. + * + * @param transitNumber + */ @JsonProperty(JSON_PROPERTY_TRANSIT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransitNumber(String transitNumber) { @@ -243,6 +263,11 @@ public TypeEnum getType() { } + /** + * **caLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CZLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/CZLocalAccountIdentification.java index 0f75a931a..27bf7bae8 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/CZLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Kód banky), without separators or whitespace. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **czLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CapabilityProblem.java b/src/main/java/com/adyen/model/balanceplatform/CapabilityProblem.java index 7d6445f13..f022a45da 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CapabilityProblem.java +++ b/src/main/java/com/adyen/model/balanceplatform/CapabilityProblem.java @@ -67,6 +67,11 @@ public CapabilityProblemEntity getEntity() { } + /** + * entity + * + * @param entity + */ @JsonProperty(JSON_PROPERTY_ENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntity(CapabilityProblemEntity entity) { @@ -100,6 +105,11 @@ public List getVerificationErrors() { } + /** + * Contains information about the verification error. + * + * @param verificationErrors + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationErrors(List verificationErrors) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntity.java b/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntity.java index 96befe90d..1a53cdd1f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntity.java +++ b/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntity.java @@ -119,6 +119,11 @@ public List getDocuments() { } + /** + * List of document IDs to which the verification errors related to the capabilities correspond to. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -144,6 +149,11 @@ public String getId() { } + /** + * The ID of the entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -169,6 +179,11 @@ public CapabilityProblemEntityRecursive getOwner() { } + /** + * owner + * + * @param owner + */ @JsonProperty(JSON_PROPERTY_OWNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwner(CapabilityProblemEntityRecursive owner) { @@ -194,6 +209,11 @@ public TypeEnum getType() { } + /** + * Type of entity. Possible values: **LegalEntity**, **BankAccount**, **Document**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntityRecursive.java b/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntityRecursive.java index 1b11a9c42..ea1715646 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntityRecursive.java +++ b/src/main/java/com/adyen/model/balanceplatform/CapabilityProblemEntityRecursive.java @@ -115,6 +115,11 @@ public List getDocuments() { } + /** + * List of document IDs to which the verification errors related to the capabilities correspond to. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -140,6 +145,11 @@ public String getId() { } + /** + * The ID of the entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -165,6 +175,11 @@ public TypeEnum getType() { } + /** + * Type of entity. Possible values: **LegalEntity**, **BankAccount**, **Document**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CapabilitySettings.java b/src/main/java/com/adyen/model/balanceplatform/CapabilitySettings.java index 5cbc3eb2f..8f45338f2 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CapabilitySettings.java +++ b/src/main/java/com/adyen/model/balanceplatform/CapabilitySettings.java @@ -162,6 +162,11 @@ public Map getAmountPerIndustry() { } + /** + * + * + * @param amountPerIndustry + */ @JsonProperty(JSON_PROPERTY_AMOUNT_PER_INDUSTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountPerIndustry(Map amountPerIndustry) { @@ -187,6 +192,11 @@ public Boolean getAuthorizedCardUsers() { } + /** + * + * + * @param authorizedCardUsers + */ @JsonProperty(JSON_PROPERTY_AUTHORIZED_CARD_USERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorizedCardUsers(Boolean authorizedCardUsers) { @@ -220,6 +230,11 @@ public List getFundingSource() { } + /** + * + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(List fundingSource) { @@ -245,6 +260,11 @@ public IntervalEnum getInterval() { } + /** + * + * + * @param interval + */ @JsonProperty(JSON_PROPERTY_INTERVAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterval(IntervalEnum interval) { @@ -270,6 +290,11 @@ public Amount getMaxAmount() { } + /** + * maxAmount + * + * @param maxAmount + */ @JsonProperty(JSON_PROPERTY_MAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxAmount(Amount maxAmount) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CapitalBalance.java b/src/main/java/com/adyen/model/balanceplatform/CapitalBalance.java index bedff4b71..e0f4690e4 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CapitalBalance.java +++ b/src/main/java/com/adyen/model/balanceplatform/CapitalBalance.java @@ -71,6 +71,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -96,6 +101,11 @@ public Long getFee() { } + /** + * Fee amount. + * + * @param fee + */ @JsonProperty(JSON_PROPERTY_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFee(Long fee) { @@ -121,6 +131,11 @@ public Long getPrincipal() { } + /** + * Principal amount. + * + * @param principal + */ @JsonProperty(JSON_PROPERTY_PRINCIPAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrincipal(Long principal) { @@ -146,6 +161,11 @@ public Long getTotal() { } + /** + * Total amount. A sum of principal amount and fee amount. + * + * @param total + */ @JsonProperty(JSON_PROPERTY_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotal(Long total) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CapitalGrantAccount.java b/src/main/java/com/adyen/model/balanceplatform/CapitalGrantAccount.java index 596012da4..d11978881 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CapitalGrantAccount.java +++ b/src/main/java/com/adyen/model/balanceplatform/CapitalGrantAccount.java @@ -83,6 +83,11 @@ public List getBalances() { } + /** + * The balances of the grant account. + * + * @param balances + */ @JsonProperty(JSON_PROPERTY_BALANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalances(List balances) { @@ -108,6 +113,11 @@ public String getFundingBalanceAccountId() { } + /** + * The unique identifier of the balance account used to fund the grant. + * + * @param fundingBalanceAccountId + */ @JsonProperty(JSON_PROPERTY_FUNDING_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingBalanceAccountId(String fundingBalanceAccountId) { @@ -133,6 +143,11 @@ public String getId() { } + /** + * The identifier of the grant account. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -166,6 +181,11 @@ public List getLimits() { } + /** + * The limits of the grant account. + * + * @param limits + */ @JsonProperty(JSON_PROPERTY_LIMITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLimits(List limits) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Card.java b/src/main/java/com/adyen/model/balanceplatform/Card.java index 318bed281..a6bad554d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Card.java +++ b/src/main/java/com/adyen/model/balanceplatform/Card.java @@ -148,6 +148,11 @@ public Authentication getAuthentication() { } + /** + * authentication + * + * @param authentication + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthentication(Authentication authentication) { @@ -173,6 +178,11 @@ public String getBin() { } + /** + * The bank identification number (BIN) of the card number. + * + * @param bin + */ @JsonProperty(JSON_PROPERTY_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBin(String bin) { @@ -198,6 +208,11 @@ public String getBrand() { } + /** + * The brand of the physical or the virtual card. Possible values: **visa**, **mc**. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -223,6 +238,11 @@ public String getBrandVariant() { } + /** + * The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**. >Reach out to your Adyen contact to get the values relevant for your integration. + * + * @param brandVariant + */ @JsonProperty(JSON_PROPERTY_BRAND_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrandVariant(String brandVariant) { @@ -248,6 +268,11 @@ public String getCardholderName() { } + /** + * The name of the cardholder. Maximum length: 26 characters. + * + * @param cardholderName + */ @JsonProperty(JSON_PROPERTY_CARDHOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardholderName(String cardholderName) { @@ -273,6 +298,11 @@ public CardConfiguration getConfiguration() { } + /** + * configuration + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(CardConfiguration configuration) { @@ -298,6 +328,11 @@ public String getCvc() { } + /** + * The CVC2 value of the card. > The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -323,6 +358,11 @@ public DeliveryContact getDeliveryContact() { } + /** + * deliveryContact + * + * @param deliveryContact + */ @JsonProperty(JSON_PROPERTY_DELIVERY_CONTACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryContact(DeliveryContact deliveryContact) { @@ -348,6 +388,11 @@ public Expiry getExpiration() { } + /** + * expiration + * + * @param expiration + */ @JsonProperty(JSON_PROPERTY_EXPIRATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiration(Expiry expiration) { @@ -373,6 +418,11 @@ public FormFactorEnum getFormFactor() { } + /** + * The form factor of the card. Possible values: **virtual**, **physical**. + * + * @param formFactor + */ @JsonProperty(JSON_PROPERTY_FORM_FACTOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormFactor(FormFactorEnum formFactor) { @@ -398,6 +448,11 @@ public String getLastFour() { } + /** + * Last last four digits of the card number. + * + * @param lastFour + */ @JsonProperty(JSON_PROPERTY_LAST_FOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastFour(String lastFour) { @@ -423,6 +478,11 @@ public String getNumber() { } + /** + * The primary account number (PAN) of the card. > The PAN is masked by default and returned only for single-use virtual cards. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -448,6 +508,11 @@ public String getThreeDSecure() { } + /** + * Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. >Reach out to your Adyen contact to get the values relevant for your integration. + * + * @param threeDSecure + */ @JsonProperty(JSON_PROPERTY_THREE_D_SECURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSecure(String threeDSecure) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CardConfiguration.java b/src/main/java/com/adyen/model/balanceplatform/CardConfiguration.java index fe4ef57d0..c9e461ec4 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CardConfiguration.java +++ b/src/main/java/com/adyen/model/balanceplatform/CardConfiguration.java @@ -112,6 +112,11 @@ public String getActivation() { } + /** + * Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions. + * + * @param activation + */ @JsonProperty(JSON_PROPERTY_ACTIVATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActivation(String activation) { @@ -137,6 +142,11 @@ public String getActivationUrl() { } + /** + * Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. Maximum length: 255 characters. + * + * @param activationUrl + */ @JsonProperty(JSON_PROPERTY_ACTIVATION_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActivationUrl(String activationUrl) { @@ -162,6 +172,11 @@ public BulkAddress getBulkAddress() { } + /** + * bulkAddress + * + * @param bulkAddress + */ @JsonProperty(JSON_PROPERTY_BULK_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBulkAddress(BulkAddress bulkAddress) { @@ -187,6 +202,11 @@ public String getCardImageId() { } + /** + * The ID of the card image. This is the image that will be printed on the full front of the card. + * + * @param cardImageId + */ @JsonProperty(JSON_PROPERTY_CARD_IMAGE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardImageId(String cardImageId) { @@ -212,6 +232,11 @@ public String getCarrier() { } + /** + * Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached. + * + * @param carrier + */ @JsonProperty(JSON_PROPERTY_CARRIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarrier(String carrier) { @@ -237,6 +262,11 @@ public String getCarrierImageId() { } + /** + * The ID of the carrier image. This is the image that will printed on the letter to which the card is attached. + * + * @param carrierImageId + */ @JsonProperty(JSON_PROPERTY_CARRIER_IMAGE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarrierImageId(String carrierImageId) { @@ -262,6 +292,11 @@ public String getConfigurationProfileId() { } + /** + * The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile. + * + * @param configurationProfileId + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION_PROFILE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfigurationProfileId(String configurationProfileId) { @@ -287,6 +322,11 @@ public String getCurrency() { } + /** + * The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -312,6 +352,11 @@ public String getEnvelope() { } + /** + * Overrides the envelope design ID defined in the `configurationProfileId`. + * + * @param envelope + */ @JsonProperty(JSON_PROPERTY_ENVELOPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvelope(String envelope) { @@ -337,6 +382,11 @@ public String getInsert() { } + /** + * Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card. + * + * @param insert + */ @JsonProperty(JSON_PROPERTY_INSERT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInsert(String insert) { @@ -362,6 +412,11 @@ public String getLanguage() { } + /** + * The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -387,6 +442,11 @@ public String getLogoImageId() { } + /** + * The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner. + * + * @param logoImageId + */ @JsonProperty(JSON_PROPERTY_LOGO_IMAGE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLogoImageId(String logoImageId) { @@ -412,6 +472,11 @@ public String getPinMailer() { } + /** + * Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed. + * + * @param pinMailer + */ @JsonProperty(JSON_PROPERTY_PIN_MAILER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPinMailer(String pinMailer) { @@ -437,6 +502,11 @@ public String getShipmentMethod() { } + /** + * Overrides the logistics company defined in the `configurationProfileId`. + * + * @param shipmentMethod + */ @JsonProperty(JSON_PROPERTY_SHIPMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipmentMethod(String shipmentMethod) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CardInfo.java b/src/main/java/com/adyen/model/balanceplatform/CardInfo.java index efeba2f68..1da915443 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CardInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/CardInfo.java @@ -127,6 +127,11 @@ public Authentication getAuthentication() { } + /** + * authentication + * + * @param authentication + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthentication(Authentication authentication) { @@ -152,6 +157,11 @@ public String getBrand() { } + /** + * The brand of the physical or the virtual card. Possible values: **visa**, **mc**. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -177,6 +187,11 @@ public String getBrandVariant() { } + /** + * The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**. >Reach out to your Adyen contact to get the values relevant for your integration. + * + * @param brandVariant + */ @JsonProperty(JSON_PROPERTY_BRAND_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrandVariant(String brandVariant) { @@ -202,6 +217,11 @@ public String getCardholderName() { } + /** + * The name of the cardholder. Maximum length: 26 characters. + * + * @param cardholderName + */ @JsonProperty(JSON_PROPERTY_CARDHOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardholderName(String cardholderName) { @@ -227,6 +247,11 @@ public CardConfiguration getConfiguration() { } + /** + * configuration + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(CardConfiguration configuration) { @@ -252,6 +277,11 @@ public DeliveryContact getDeliveryContact() { } + /** + * deliveryContact + * + * @param deliveryContact + */ @JsonProperty(JSON_PROPERTY_DELIVERY_CONTACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryContact(DeliveryContact deliveryContact) { @@ -277,6 +307,11 @@ public FormFactorEnum getFormFactor() { } + /** + * The form factor of the card. Possible values: **virtual**, **physical**. + * + * @param formFactor + */ @JsonProperty(JSON_PROPERTY_FORM_FACTOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormFactor(FormFactorEnum formFactor) { @@ -302,6 +337,11 @@ public String getThreeDSecure() { } + /** + * Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. >Reach out to your Adyen contact to get the values relevant for your integration. + * + * @param threeDSecure + */ @JsonProperty(JSON_PROPERTY_THREE_D_SECURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSecure(String threeDSecure) { diff --git a/src/main/java/com/adyen/model/balanceplatform/ContactDetails.java b/src/main/java/com/adyen/model/balanceplatform/ContactDetails.java index e6eb44f1b..e4a72027a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/ContactDetails.java +++ b/src/main/java/com/adyen/model/balanceplatform/ContactDetails.java @@ -73,6 +73,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -98,6 +103,11 @@ public String getEmail() { } + /** + * The email address of the account holder. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -123,6 +133,11 @@ public Phone getPhone() { } + /** + * phone + * + * @param phone + */ @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhone(Phone phone) { @@ -148,6 +163,11 @@ public String getWebAddress() { } + /** + * The URL of the account holder's website. + * + * @param webAddress + */ @JsonProperty(JSON_PROPERTY_WEB_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebAddress(String webAddress) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Counterparty.java b/src/main/java/com/adyen/model/balanceplatform/Counterparty.java index 3c5c5cc03..cd755224a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Counterparty.java +++ b/src/main/java/com/adyen/model/balanceplatform/Counterparty.java @@ -64,6 +64,11 @@ public BankAccount getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccount bankAccount) { @@ -89,6 +94,11 @@ public String getTransferInstrumentId() { } + /** + * Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CounterpartyBankRestriction.java b/src/main/java/com/adyen/model/balanceplatform/CounterpartyBankRestriction.java index 2b014896e..d2a498263 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CounterpartyBankRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/CounterpartyBankRestriction.java @@ -66,6 +66,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -99,6 +104,11 @@ public List getValue() { } + /** + * List of counterparty Bank Institutions and the operation. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CountriesRestriction.java b/src/main/java/com/adyen/model/balanceplatform/CountriesRestriction.java index fc1a822d5..d6a8fc06d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CountriesRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/CountriesRestriction.java @@ -65,6 +65,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -98,6 +103,11 @@ public List getValue() { } + /** + * List of two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/CreateSweepConfigurationV2.java b/src/main/java/com/adyen/model/balanceplatform/CreateSweepConfigurationV2.java index e278b2373..f1793b793 100644 --- a/src/main/java/com/adyen/model/balanceplatform/CreateSweepConfigurationV2.java +++ b/src/main/java/com/adyen/model/balanceplatform/CreateSweepConfigurationV2.java @@ -321,6 +321,11 @@ public CategoryEnum getCategory() { } + /** + * The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -346,6 +351,11 @@ public SweepCounterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(SweepCounterparty counterparty) { @@ -371,6 +381,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -396,6 +411,11 @@ public String getDescription() { } + /** + * The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -429,6 +449,11 @@ public List getPriorities() { } + /** + * The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that's not possible, it moves on to the next option in the order of provided priorities. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup). + * + * @param priorities + */ @JsonProperty(JSON_PROPERTY_PRIORITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriorities(List priorities) { @@ -454,6 +479,11 @@ public ReasonEnum getReason() { } + /** + * The reason for disabling the sweep. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -479,6 +509,11 @@ public SweepSchedule getSchedule() { } + /** + * schedule + * + * @param schedule + */ @JsonProperty(JSON_PROPERTY_SCHEDULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSchedule(SweepSchedule schedule) { @@ -504,6 +539,11 @@ public StatusEnum getStatus() { } + /** + * The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -529,6 +569,11 @@ public Amount getSweepAmount() { } + /** + * sweepAmount + * + * @param sweepAmount + */ @JsonProperty(JSON_PROPERTY_SWEEP_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSweepAmount(Amount sweepAmount) { @@ -554,6 +599,11 @@ public Amount getTargetAmount() { } + /** + * targetAmount + * + * @param targetAmount + */ @JsonProperty(JSON_PROPERTY_TARGET_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTargetAmount(Amount targetAmount) { @@ -579,6 +629,11 @@ public Amount getTriggerAmount() { } + /** + * triggerAmount + * + * @param triggerAmount + */ @JsonProperty(JSON_PROPERTY_TRIGGER_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTriggerAmount(Amount triggerAmount) { @@ -604,6 +659,11 @@ public TypeEnum getType() { } + /** + * The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/DKLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/DKLocalAccountIdentification.java index 076fe3458..2d9062158 100644 --- a/src/main/java/com/adyen/model/balanceplatform/DKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/DKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Registreringsnummer) (without separators or whitespace). + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **dkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/DayOfWeekRestriction.java b/src/main/java/com/adyen/model/balanceplatform/DayOfWeekRestriction.java index 601ba6e57..ddb1760ff 100644 --- a/src/main/java/com/adyen/model/balanceplatform/DayOfWeekRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/DayOfWeekRestriction.java @@ -110,6 +110,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -143,6 +148,11 @@ public List getValue() { } + /** + * List of days of the week. Possible values: **monday**, **tuesday**, **wednesday**, **thursday**, **friday**, **saturday**, **sunday**. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/DeliveryAddress.java b/src/main/java/com/adyen/model/balanceplatform/DeliveryAddress.java index 907c96ec6..5ded1659f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/DeliveryAddress.java +++ b/src/main/java/com/adyen/model/balanceplatform/DeliveryAddress.java @@ -83,6 +83,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -108,6 +113,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. >If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -133,6 +143,11 @@ public String getLine1() { } + /** + * The street name. For example, if the address is \"Rokin 49\", provide \"Rokin\". + * + * @param line1 + */ @JsonProperty(JSON_PROPERTY_LINE1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine1(String line1) { @@ -158,6 +173,11 @@ public String getLine2() { } + /** + * The house number or name. For example, if the address is \"Rokin 49\", provide \"49\". + * + * @param line2 + */ @JsonProperty(JSON_PROPERTY_LINE2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine2(String line2) { @@ -183,6 +203,11 @@ public String getLine3() { } + /** + * Optional information about the address. + * + * @param line3 + */ @JsonProperty(JSON_PROPERTY_LINE3) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine3(String line3) { @@ -208,6 +233,11 @@ public String getPostalCode() { } + /** + * The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -233,6 +263,11 @@ public String getStateOrProvince() { } + /** + * The two-letterISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { diff --git a/src/main/java/com/adyen/model/balanceplatform/DeliveryContact.java b/src/main/java/com/adyen/model/balanceplatform/DeliveryContact.java index eba1ae3f7..d506a197d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/DeliveryContact.java +++ b/src/main/java/com/adyen/model/balanceplatform/DeliveryContact.java @@ -82,6 +82,11 @@ public DeliveryAddress getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(DeliveryAddress address) { @@ -107,6 +112,11 @@ public String getEmail() { } + /** + * The email address of the contact. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -132,6 +142,11 @@ public String getFullPhoneNumber() { } + /** + * The full phone number of the contact provided as a single string. It will be handled as a landline phone. **Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + * + * @param fullPhoneNumber + */ @JsonProperty(JSON_PROPERTY_FULL_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFullPhoneNumber(String fullPhoneNumber) { @@ -157,6 +172,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -182,6 +202,11 @@ public PhoneNumber getPhoneNumber() { } + /** + * phoneNumber + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(PhoneNumber phoneNumber) { @@ -207,6 +232,11 @@ public String getWebAddress() { } + /** + * The URL of the contact's website. + * + * @param webAddress + */ @JsonProperty(JSON_PROPERTY_WEB_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebAddress(String webAddress) { diff --git a/src/main/java/com/adyen/model/balanceplatform/DeviceInfo.java b/src/main/java/com/adyen/model/balanceplatform/DeviceInfo.java index 73a6abcff..1f532ab49 100644 --- a/src/main/java/com/adyen/model/balanceplatform/DeviceInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/DeviceInfo.java @@ -101,6 +101,11 @@ public String getCardCaptureTechnology() { } + /** + * The technology used to capture the card details. + * + * @param cardCaptureTechnology + */ @JsonProperty(JSON_PROPERTY_CARD_CAPTURE_TECHNOLOGY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardCaptureTechnology(String cardCaptureTechnology) { @@ -126,6 +131,11 @@ public String getDeviceName() { } + /** + * The name of the device. + * + * @param deviceName + */ @JsonProperty(JSON_PROPERTY_DEVICE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceName(String deviceName) { @@ -151,6 +161,11 @@ public String getFormFactor() { } + /** + * The form factor of the device to be provisioned. + * + * @param formFactor + */ @JsonProperty(JSON_PROPERTY_FORM_FACTOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormFactor(String formFactor) { @@ -176,6 +191,11 @@ public String getImei() { } + /** + * The IMEI number of the device being provisioned. + * + * @param imei + */ @JsonProperty(JSON_PROPERTY_IMEI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setImei(String imei) { @@ -201,6 +221,11 @@ public String getIsoDeviceType() { } + /** + * The 2-digit device type provided on the ISO messages that the token is being provisioned to. + * + * @param isoDeviceType + */ @JsonProperty(JSON_PROPERTY_ISO_DEVICE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsoDeviceType(String isoDeviceType) { @@ -226,6 +251,11 @@ public String getMsisdn() { } + /** + * The MSISDN of the device being provisioned. + * + * @param msisdn + */ @JsonProperty(JSON_PROPERTY_MSISDN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMsisdn(String msisdn) { @@ -251,6 +281,11 @@ public String getOsName() { } + /** + * The name of the device operating system. + * + * @param osName + */ @JsonProperty(JSON_PROPERTY_OS_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOsName(String osName) { @@ -276,6 +311,11 @@ public String getOsVersion() { } + /** + * The version of the device operating system. + * + * @param osVersion + */ @JsonProperty(JSON_PROPERTY_OS_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOsVersion(String osVersion) { @@ -309,6 +349,11 @@ public List getPaymentTypes() { } + /** + * Different types of payments supported for the network token. + * + * @param paymentTypes + */ @JsonProperty(JSON_PROPERTY_PAYMENT_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentTypes(List paymentTypes) { @@ -334,6 +379,11 @@ public String getSerialNumber() { } + /** + * The serial number of the device. + * + * @param serialNumber + */ @JsonProperty(JSON_PROPERTY_SERIAL_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSerialNumber(String serialNumber) { @@ -359,6 +409,11 @@ public String getStorageTechnology() { } + /** + * The architecture or technology used for network token storage. + * + * @param storageTechnology + */ @JsonProperty(JSON_PROPERTY_STORAGE_TECHNOLOGY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorageTechnology(String storageTechnology) { diff --git a/src/main/java/com/adyen/model/balanceplatform/DifferentCurrenciesRestriction.java b/src/main/java/com/adyen/model/balanceplatform/DifferentCurrenciesRestriction.java index df3b7d5f3..3a96f2a96 100644 --- a/src/main/java/com/adyen/model/balanceplatform/DifferentCurrenciesRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/DifferentCurrenciesRestriction.java @@ -63,6 +63,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -88,6 +93,11 @@ public Boolean getValue() { } + /** + * Checks the currency of the payment against the currency of the payment instrument. Possible values: - **true**: The currency of the payment is different from the currency of the payment instrument. - **false**: The currencies are the same. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Boolean value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Duration.java b/src/main/java/com/adyen/model/balanceplatform/Duration.java index 108fbb8f1..905379e16 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Duration.java +++ b/src/main/java/com/adyen/model/balanceplatform/Duration.java @@ -104,6 +104,11 @@ public UnitEnum getUnit() { } + /** + * The unit of time. You can only use **minutes** and **hours** if the `interval.type` is **sliding**. Possible values: **minutes**, **hours**, **days**, **weeks**, or **months** + * + * @param unit + */ @JsonProperty(JSON_PROPERTY_UNIT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUnit(UnitEnum unit) { @@ -129,6 +134,11 @@ public Integer getValue() { } + /** + * The length of time by the unit. For example, 5 days. The maximum duration is 90 days or an equivalent in other units. For example, 3 months. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Integer value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/EntryModesRestriction.java b/src/main/java/com/adyen/model/balanceplatform/EntryModesRestriction.java index bb2865c73..fdae449b8 100644 --- a/src/main/java/com/adyen/model/balanceplatform/EntryModesRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/EntryModesRestriction.java @@ -114,6 +114,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -147,6 +152,11 @@ public List getValue() { } + /** + * List of point-of-sale entry modes. Possible values: **barcode**, **chip**, **cof**, **contactless**, **magstripe**, **manual**, **ocr**, **server**. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Expiry.java b/src/main/java/com/adyen/model/balanceplatform/Expiry.java index c1d4082e6..fa45b7a2f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Expiry.java +++ b/src/main/java/com/adyen/model/balanceplatform/Expiry.java @@ -63,6 +63,11 @@ public String getMonth() { } + /** + * The month in which the card will expire. + * + * @param month + */ @JsonProperty(JSON_PROPERTY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMonth(String month) { @@ -88,6 +93,11 @@ public String getYear() { } + /** + * The year in which the card will expire. + * + * @param year + */ @JsonProperty(JSON_PROPERTY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setYear(String year) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Fee.java b/src/main/java/com/adyen/model/balanceplatform/Fee.java index a8c59e323..f280994bb 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Fee.java +++ b/src/main/java/com/adyen/model/balanceplatform/Fee.java @@ -60,6 +60,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { diff --git a/src/main/java/com/adyen/model/balanceplatform/GetNetworkTokenResponse.java b/src/main/java/com/adyen/model/balanceplatform/GetNetworkTokenResponse.java index 73c7a5624..4d313b7bf 100644 --- a/src/main/java/com/adyen/model/balanceplatform/GetNetworkTokenResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/GetNetworkTokenResponse.java @@ -60,6 +60,11 @@ public NetworkToken getToken() { } + /** + * token + * + * @param token + */ @JsonProperty(JSON_PROPERTY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToken(NetworkToken token) { diff --git a/src/main/java/com/adyen/model/balanceplatform/GetTaxFormResponse.java b/src/main/java/com/adyen/model/balanceplatform/GetTaxFormResponse.java index 04ab6f15f..ce2963cdf 100644 --- a/src/main/java/com/adyen/model/balanceplatform/GetTaxFormResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/GetTaxFormResponse.java @@ -96,6 +96,11 @@ public byte[] getContent() { } + /** + * The content of the tax form in Base64 format. + * + * @param content + */ @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContent(byte[] content) { @@ -121,6 +126,11 @@ public ContentTypeEnum getContentType() { } + /** + * The content type of the tax form. Possible values: * **application/pdf** + * + * @param contentType + */ @JsonProperty(JSON_PROPERTY_CONTENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContentType(ContentTypeEnum contentType) { diff --git a/src/main/java/com/adyen/model/balanceplatform/GrantLimit.java b/src/main/java/com/adyen/model/balanceplatform/GrantLimit.java index dfa335bc1..5974b1a44 100644 --- a/src/main/java/com/adyen/model/balanceplatform/GrantLimit.java +++ b/src/main/java/com/adyen/model/balanceplatform/GrantLimit.java @@ -60,6 +60,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { diff --git a/src/main/java/com/adyen/model/balanceplatform/GrantOffer.java b/src/main/java/com/adyen/model/balanceplatform/GrantOffer.java index ed3a98785..91fb261e9 100644 --- a/src/main/java/com/adyen/model/balanceplatform/GrantOffer.java +++ b/src/main/java/com/adyen/model/balanceplatform/GrantOffer.java @@ -125,6 +125,11 @@ public String getAccountHolderId() { } + /** + * The identifier of the account holder to which the grant is offered. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -150,6 +155,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -175,6 +185,11 @@ public ContractTypeEnum getContractType() { } + /** + * The contract type of the grant offer. Possible value: **cashAdvance**, **loan**. + * + * @param contractType + */ @JsonProperty(JSON_PROPERTY_CONTRACT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContractType(ContractTypeEnum contractType) { @@ -200,6 +215,11 @@ public Object getExpiresAt() { } + /** + * expiresAt + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(Object expiresAt) { @@ -225,6 +245,11 @@ public Fee getFee() { } + /** + * fee + * + * @param fee + */ @JsonProperty(JSON_PROPERTY_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFee(Fee fee) { @@ -250,6 +275,11 @@ public String getId() { } + /** + * The unique identifier of the grant offer. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -275,6 +305,11 @@ public Repayment getRepayment() { } + /** + * repayment + * + * @param repayment + */ @JsonProperty(JSON_PROPERTY_REPAYMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRepayment(Repayment repayment) { @@ -300,6 +335,11 @@ public Object getStartsAt() { } + /** + * startsAt + * + * @param startsAt + */ @JsonProperty(JSON_PROPERTY_STARTS_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartsAt(Object startsAt) { diff --git a/src/main/java/com/adyen/model/balanceplatform/GrantOffers.java b/src/main/java/com/adyen/model/balanceplatform/GrantOffers.java index b5886a27e..aa75a2717 100644 --- a/src/main/java/com/adyen/model/balanceplatform/GrantOffers.java +++ b/src/main/java/com/adyen/model/balanceplatform/GrantOffers.java @@ -67,6 +67,11 @@ public List getGrantOffers() { } + /** + * A list of available grant offers. + * + * @param grantOffers + */ @JsonProperty(JSON_PROPERTY_GRANT_OFFERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGrantOffers(List grantOffers) { diff --git a/src/main/java/com/adyen/model/balanceplatform/HKLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/HKLocalAccountIdentification.java index 205b790cb..adb125ece 100644 --- a/src/main/java/com/adyen/model/balanceplatform/HKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/HKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingCode() { } + /** + * The 3-digit clearing code, without separators or whitespace. + * + * @param clearingCode + */ @JsonProperty(JSON_PROPERTY_CLEARING_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingCode(String clearingCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **hkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/HULocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/HULocalAccountIdentification.java index 31b135859..604800e2e 100644 --- a/src/main/java/com/adyen/model/balanceplatform/HULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/HULocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 24-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **huLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/IbanAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/IbanAccountIdentification.java index 6e90df2e5..289a32d0b 100644 --- a/src/main/java/com/adyen/model/balanceplatform/IbanAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/IbanAccountIdentification.java @@ -96,6 +96,11 @@ public String getIban() { } + /** + * The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **iban** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/InternationalTransactionRestriction.java b/src/main/java/com/adyen/model/balanceplatform/InternationalTransactionRestriction.java index a27029f1a..98f810576 100644 --- a/src/main/java/com/adyen/model/balanceplatform/InternationalTransactionRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/InternationalTransactionRestriction.java @@ -63,6 +63,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -88,6 +93,11 @@ public Boolean getValue() { } + /** + * Boolean indicating whether transaction is an international transaction. Possible values: - **true**: The transaction is an international transaction. - **false**: The transaction is a domestic transaction. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Boolean value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/InvalidField.java b/src/main/java/com/adyen/model/balanceplatform/InvalidField.java index b62f57fda..ab0f50d58 100644 --- a/src/main/java/com/adyen/model/balanceplatform/InvalidField.java +++ b/src/main/java/com/adyen/model/balanceplatform/InvalidField.java @@ -67,6 +67,11 @@ public String getMessage() { } + /** + * Description of the validation error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -92,6 +97,11 @@ public String getName() { } + /** + * The field that has an invalid value. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -117,6 +127,11 @@ public String getValue() { } + /** + * The invalid value. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(String value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/ListNetworkTokensResponse.java b/src/main/java/com/adyen/model/balanceplatform/ListNetworkTokensResponse.java index 0ecf42779..c8da6b95f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/ListNetworkTokensResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/ListNetworkTokensResponse.java @@ -70,6 +70,11 @@ public List getNetworkTokens() { } + /** + * List of network tokens. + * + * @param networkTokens + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKENS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokens(List networkTokens) { diff --git a/src/main/java/com/adyen/model/balanceplatform/MatchingTransactionsRestriction.java b/src/main/java/com/adyen/model/balanceplatform/MatchingTransactionsRestriction.java index 0ce1f04a7..5180b8f7c 100644 --- a/src/main/java/com/adyen/model/balanceplatform/MatchingTransactionsRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/MatchingTransactionsRestriction.java @@ -63,6 +63,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -88,6 +93,11 @@ public Integer getValue() { } + /** + * The number of transactions. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Integer value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/MccsRestriction.java b/src/main/java/com/adyen/model/balanceplatform/MccsRestriction.java index 01137ee9a..293929088 100644 --- a/src/main/java/com/adyen/model/balanceplatform/MccsRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/MccsRestriction.java @@ -65,6 +65,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -98,6 +103,11 @@ public List getValue() { } + /** + * List of merchant category codes (MCCs). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/MerchantAcquirerPair.java b/src/main/java/com/adyen/model/balanceplatform/MerchantAcquirerPair.java index 7050892e8..09d17b6ca 100644 --- a/src/main/java/com/adyen/model/balanceplatform/MerchantAcquirerPair.java +++ b/src/main/java/com/adyen/model/balanceplatform/MerchantAcquirerPair.java @@ -63,6 +63,11 @@ public String getAcquirerId() { } + /** + * The acquirer ID. + * + * @param acquirerId + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerId(String acquirerId) { @@ -88,6 +93,11 @@ public String getMerchantId() { } + /** + * The merchant identification number (MID). + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { diff --git a/src/main/java/com/adyen/model/balanceplatform/MerchantNamesRestriction.java b/src/main/java/com/adyen/model/balanceplatform/MerchantNamesRestriction.java index eb087aeb6..7f96a0862 100644 --- a/src/main/java/com/adyen/model/balanceplatform/MerchantNamesRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/MerchantNamesRestriction.java @@ -66,6 +66,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -99,6 +104,11 @@ public List getValue() { } + /** + * value + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/MerchantsRestriction.java b/src/main/java/com/adyen/model/balanceplatform/MerchantsRestriction.java index 1f7fe581c..7829dc260 100644 --- a/src/main/java/com/adyen/model/balanceplatform/MerchantsRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/MerchantsRestriction.java @@ -66,6 +66,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -99,6 +104,11 @@ public List getValue() { } + /** + * List of merchant ID and acquirer ID pairs. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/NOLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/NOLocalAccountIdentification.java index b2fc9e4b8..31ecaf65e 100644 --- a/src/main/java/com/adyen/model/balanceplatform/NOLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/NOLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 11-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **noLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/NZLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/NZLocalAccountIdentification.java index 56a226ca4..4a1b9b00f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/NZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/NZLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **nzLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Name.java b/src/main/java/com/adyen/model/balanceplatform/Name.java index c359c957b..cb4f7a614 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Name.java +++ b/src/main/java/com/adyen/model/balanceplatform/Name.java @@ -63,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -88,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/balanceplatform/NetworkToken.java b/src/main/java/com/adyen/model/balanceplatform/NetworkToken.java index 91cd9755c..e1226efaf 100644 --- a/src/main/java/com/adyen/model/balanceplatform/NetworkToken.java +++ b/src/main/java/com/adyen/model/balanceplatform/NetworkToken.java @@ -128,6 +128,11 @@ public String getBrandVariant() { } + /** + * The card brand variant of the payment instrument associated with the network token. For example, **mc_prepaid_mrw**. + * + * @param brandVariant + */ @JsonProperty(JSON_PROPERTY_BRAND_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrandVariant(String brandVariant) { @@ -153,6 +158,11 @@ public OffsetDateTime getCreationDate() { } + /** + * Date and time when the network token was created, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) extended format. For example, **2020-12-18T10:15:30+01:00**.. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -178,6 +188,11 @@ public DeviceInfo getDevice() { } + /** + * device + * + * @param device + */ @JsonProperty(JSON_PROPERTY_DEVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDevice(DeviceInfo device) { @@ -203,6 +218,11 @@ public String getId() { } + /** + * The unique identifier of the network token. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -228,6 +248,11 @@ public String getPaymentInstrumentId() { } + /** + * The unique identifier of the payment instrument to which this network token belongs to. + * + * @param paymentInstrumentId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentId(String paymentInstrumentId) { @@ -253,6 +278,11 @@ public StatusEnum getStatus() { } + /** + * The status of the network token. Possible values: **active**, **inactive**, **suspended**, **closed**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -278,6 +308,11 @@ public String getTokenLastFour() { } + /** + * The last four digits of the network token `id`. + * + * @param tokenLastFour + */ @JsonProperty(JSON_PROPERTY_TOKEN_LAST_FOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenLastFour(String tokenLastFour) { @@ -303,6 +338,11 @@ public String getType() { } + /** + * The type of wallet the network token is associated with. For example, **applePay**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/NumberAndBicAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/NumberAndBicAccountIdentification.java index 54492d5bc..12f98f1ba 100644 --- a/src/main/java/com/adyen/model/balanceplatform/NumberAndBicAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/NumberAndBicAccountIdentification.java @@ -105,6 +105,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. The length and format depends on the bank or country. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -130,6 +135,11 @@ public AdditionalBankIdentification getAdditionalBankIdentification() { } + /** + * additionalBankIdentification + * + * @param additionalBankIdentification + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_BANK_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalBankIdentification(AdditionalBankIdentification additionalBankIdentification) { @@ -155,6 +165,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -180,6 +195,11 @@ public TypeEnum getType() { } + /** + * **numberAndBic** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PLLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/PLLocalAccountIdentification.java index 02cf3d557..68146c03d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PLLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/PLLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **plLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaginatedAccountHoldersResponse.java b/src/main/java/com/adyen/model/balanceplatform/PaginatedAccountHoldersResponse.java index 9155743ed..01285a781 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaginatedAccountHoldersResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaginatedAccountHoldersResponse.java @@ -75,6 +75,11 @@ public List getAccountHolders() { } + /** + * List of account holders. + * + * @param accountHolders + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolders(List accountHolders) { @@ -100,6 +105,11 @@ public Boolean getHasNext() { } + /** + * Indicates whether there are more items on the next page. + * + * @param hasNext + */ @JsonProperty(JSON_PROPERTY_HAS_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasNext(Boolean hasNext) { @@ -125,6 +135,11 @@ public Boolean getHasPrevious() { } + /** + * Indicates whether there are more items on the previous page. + * + * @param hasPrevious + */ @JsonProperty(JSON_PROPERTY_HAS_PREVIOUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasPrevious(Boolean hasPrevious) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaginatedBalanceAccountsResponse.java b/src/main/java/com/adyen/model/balanceplatform/PaginatedBalanceAccountsResponse.java index ffc36bf28..48163a12a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaginatedBalanceAccountsResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaginatedBalanceAccountsResponse.java @@ -75,6 +75,11 @@ public List getBalanceAccounts() { } + /** + * List of balance accounts. + * + * @param balanceAccounts + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccounts(List balanceAccounts) { @@ -100,6 +105,11 @@ public Boolean getHasNext() { } + /** + * Indicates whether there are more items on the next page. + * + * @param hasNext + */ @JsonProperty(JSON_PROPERTY_HAS_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasNext(Boolean hasNext) { @@ -125,6 +135,11 @@ public Boolean getHasPrevious() { } + /** + * Indicates whether there are more items on the previous page. + * + * @param hasPrevious + */ @JsonProperty(JSON_PROPERTY_HAS_PREVIOUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasPrevious(Boolean hasPrevious) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaginatedPaymentInstrumentsResponse.java b/src/main/java/com/adyen/model/balanceplatform/PaginatedPaymentInstrumentsResponse.java index ce36d0902..f86d1373a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaginatedPaymentInstrumentsResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaginatedPaymentInstrumentsResponse.java @@ -70,6 +70,11 @@ public Boolean getHasNext() { } + /** + * Indicates whether there are more items on the next page. + * + * @param hasNext + */ @JsonProperty(JSON_PROPERTY_HAS_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasNext(Boolean hasNext) { @@ -95,6 +100,11 @@ public Boolean getHasPrevious() { } + /** + * Indicates whether there are more items on the previous page. + * + * @param hasPrevious + */ @JsonProperty(JSON_PROPERTY_HAS_PREVIOUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasPrevious(Boolean hasPrevious) { @@ -125,6 +135,11 @@ public List getPaymentInstruments() { } + /** + * List of payment instruments associated with the balance account. + * + * @param paymentInstruments + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstruments(List paymentInstruments) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrument.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrument.java index a4d1422e3..5fd6098c9 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrument.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrument.java @@ -224,6 +224,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -249,6 +254,11 @@ public PaymentInstrumentBankAccount getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(PaymentInstrumentBankAccount bankAccount) { @@ -274,6 +284,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -299,6 +314,11 @@ public String getDescription() { } + /** + * Your description for the payment instrument, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -324,6 +344,11 @@ public String getId() { } + /** + * The unique identifier of the payment instrument. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -349,6 +374,11 @@ public String getIssuingCountryCode() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. + * + * @param issuingCountryCode + */ @JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCountryCode(String issuingCountryCode) { @@ -374,6 +404,11 @@ public String getPaymentInstrumentGroupId() { } + /** + * The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. + * + * @param paymentInstrumentGroupId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentGroupId(String paymentInstrumentGroupId) { @@ -399,6 +434,11 @@ public String getReference() { } + /** + * Your reference for the payment instrument, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -424,6 +464,11 @@ public StatusEnum getStatus() { } + /** + * The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**. Possible values: * **active**: The payment instrument is active and can be used to make payments. * **inactive**: The payment instrument is inactive and cannot be used to make payments. * **suspended**: The payment instrument is suspended, either because it was stolen or lost. * **closed**: The payment instrument is permanently closed. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -449,6 +494,11 @@ public StatusReasonEnum getStatusReason() { } + /** + * The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change. + * + * @param statusReason + */ @JsonProperty(JSON_PROPERTY_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatusReason(StatusReasonEnum statusReason) { @@ -474,6 +524,11 @@ public TypeEnum getType() { } + /** + * Type of payment instrument. Possible value: **card**, **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroup.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroup.java index aba28c53a..37ffe5a63 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroup.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroup.java @@ -82,6 +82,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -107,6 +112,11 @@ public String getDescription() { } + /** + * Your description for the payment instrument group, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -132,6 +142,11 @@ public String getId() { } + /** + * The unique identifier of the payment instrument group. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -165,6 +180,11 @@ public Map getProperties() { } + /** + * Properties of the payment instrument group. + * + * @param properties + */ @JsonProperty(JSON_PROPERTY_PROPERTIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProperties(Map properties) { @@ -190,6 +210,11 @@ public String getReference() { } + /** + * Your reference for the payment instrument group, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -215,6 +240,11 @@ public String getTxVariant() { } + /** + * The tx variant of the payment instrument group. + * + * @param txVariant + */ @JsonProperty(JSON_PROPERTY_TX_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxVariant(String txVariant) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroupInfo.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroupInfo.java index 558a928b1..a60c71e3b 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroupInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentGroupInfo.java @@ -78,6 +78,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the payment instrument group belongs. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -103,6 +108,11 @@ public String getDescription() { } + /** + * Your description for the payment instrument group, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -136,6 +146,11 @@ public Map getProperties() { } + /** + * Properties of the payment instrument group. + * + * @param properties + */ @JsonProperty(JSON_PROPERTY_PROPERTIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProperties(Map properties) { @@ -161,6 +176,11 @@ public String getReference() { } + /** + * Your reference for the payment instrument group, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -186,6 +206,11 @@ public String getTxVariant() { } + /** + * The tx variant of the payment instrument group. + * + * @param txVariant + */ @JsonProperty(JSON_PROPERTY_TX_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxVariant(String txVariant) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentInfo.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentInfo.java index 400afe8fa..e1705c606 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentInfo.java @@ -215,6 +215,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -240,6 +245,11 @@ public CardInfo getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(CardInfo card) { @@ -265,6 +275,11 @@ public String getDescription() { } + /** + * Your description for the payment instrument, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -290,6 +305,11 @@ public String getIssuingCountryCode() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. + * + * @param issuingCountryCode + */ @JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCountryCode(String issuingCountryCode) { @@ -315,6 +335,11 @@ public String getPaymentInstrumentGroupId() { } + /** + * The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. + * + * @param paymentInstrumentGroupId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentGroupId(String paymentInstrumentGroupId) { @@ -340,6 +365,11 @@ public String getReference() { } + /** + * Your reference for the payment instrument, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -365,6 +395,11 @@ public StatusEnum getStatus() { } + /** + * The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**. Possible values: * **active**: The payment instrument is active and can be used to make payments. * **inactive**: The payment instrument is inactive and cannot be used to make payments. * **suspended**: The payment instrument is suspended, either because it was stolen or lost. * **closed**: The payment instrument is permanently closed. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -390,6 +425,11 @@ public StatusReasonEnum getStatusReason() { } + /** + * The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change. + * + * @param statusReason + */ @JsonProperty(JSON_PROPERTY_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatusReason(StatusReasonEnum statusReason) { @@ -415,6 +455,11 @@ public TypeEnum getType() { } + /** + * Type of payment instrument. Possible value: **card**, **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRequirement.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRequirement.java index 5c7b98167..4e52df735 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRequirement.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRequirement.java @@ -143,6 +143,11 @@ public String getDescription() { } + /** + * Specifies the requirements for the payment instrument that need to be included in the request for a particular route. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -168,6 +173,11 @@ public String getIssuingCountryCode() { } + /** + * The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. + * + * @param issuingCountryCode + */ @JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCountryCode(String issuingCountryCode) { @@ -193,6 +203,11 @@ public Boolean getOnlyForCrossBalancePlatform() { } + /** + * Specifies if the requirement only applies to transfers to another balance platform. + * + * @param onlyForCrossBalancePlatform + */ @JsonProperty(JSON_PROPERTY_ONLY_FOR_CROSS_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOnlyForCrossBalancePlatform(Boolean onlyForCrossBalancePlatform) { @@ -218,6 +233,11 @@ public PaymentInstrumentTypeEnum getPaymentInstrumentType() { } + /** + * The type of the payment instrument. For example, \"BankAccount\" or \"Card\". + * + * @param paymentInstrumentType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentType(PaymentInstrumentTypeEnum paymentInstrumentType) { @@ -243,6 +263,11 @@ public TypeEnum getType() { } + /** + * **paymentInstrumentRequirement** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRevealInfo.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRevealInfo.java index 992e64a92..06b3eb1da 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRevealInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentRevealInfo.java @@ -68,6 +68,11 @@ public String getCvc() { } + /** + * The CVC2 value of the card. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -93,6 +98,11 @@ public Expiry getExpiration() { } + /** + * expiration + * + * @param expiration + */ @JsonProperty(JSON_PROPERTY_EXPIRATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiration(Expiry expiration) { @@ -118,6 +128,11 @@ public String getPan() { } + /** + * The primary account number (PAN) of the card. + * + * @param pan + */ @JsonProperty(JSON_PROPERTY_PAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPan(String pan) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentUpdateRequest.java b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentUpdateRequest.java index a12575fc3..f09d5ec60 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentUpdateRequest.java +++ b/src/main/java/com/adyen/model/balanceplatform/PaymentInstrumentUpdateRequest.java @@ -164,6 +164,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the balance account associated with this payment instrument. >You can only change the balance account ID if the payment instrument has **inactive** status. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -189,6 +194,11 @@ public CardInfo getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(CardInfo card) { @@ -214,6 +224,11 @@ public StatusEnum getStatus() { } + /** + * The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**. Possible values: * **active**: The payment instrument is active and can be used to make payments. * **inactive**: The payment instrument is inactive and cannot be used to make payments. * **suspended**: The payment instrument is suspended, either because it was stolen or lost. * **closed**: The payment instrument is permanently closed. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -239,6 +254,11 @@ public String getStatusComment() { } + /** + * Comment for the status of the payment instrument. Required if `statusReason` is **other**. + * + * @param statusComment + */ @JsonProperty(JSON_PROPERTY_STATUS_COMMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatusComment(String statusComment) { @@ -264,6 +284,11 @@ public StatusReasonEnum getStatusReason() { } + /** + * The reason for updating the status of the payment instrument. Possible values: **lost**, **stolen**, **damaged**, **suspectedFraud**, **expired**, **endOfLife**, **accountClosure**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change. + * + * @param statusReason + */ @JsonProperty(JSON_PROPERTY_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatusReason(StatusReasonEnum statusReason) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Phone.java b/src/main/java/com/adyen/model/balanceplatform/Phone.java index ce6185c4a..0f2f1e09a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Phone.java +++ b/src/main/java/com/adyen/model/balanceplatform/Phone.java @@ -98,6 +98,11 @@ public String getNumber() { } + /** + * The full phone number provided as a single string. For example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, or **\"(0031) 611223344\"**. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * Type of phone number. Possible values: **Landline**, **Mobile**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PhoneNumber.java b/src/main/java/com/adyen/model/balanceplatform/PhoneNumber.java index 2daf9787d..cfdfc58db 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PhoneNumber.java +++ b/src/main/java/com/adyen/model/balanceplatform/PhoneNumber.java @@ -106,6 +106,11 @@ public String getPhoneCountryCode() { } + /** + * The two-character ISO-3166-1 alpha-2 country code of the phone number. For example, **US** or **NL**. + * + * @param phoneCountryCode + */ @JsonProperty(JSON_PROPERTY_PHONE_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneCountryCode(String phoneCountryCode) { @@ -131,6 +136,11 @@ public String getPhoneNumber() { } + /** + * The phone number. The inclusion of the phone number country code is not necessary. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -156,6 +166,11 @@ public PhoneTypeEnum getPhoneType() { } + /** + * The type of the phone number. Possible values: **Landline**, **Mobile**, **SIP**, **Fax**. + * + * @param phoneType + */ @JsonProperty(JSON_PROPERTY_PHONE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneType(PhoneTypeEnum phoneType) { diff --git a/src/main/java/com/adyen/model/balanceplatform/PlatformPaymentConfiguration.java b/src/main/java/com/adyen/model/balanceplatform/PlatformPaymentConfiguration.java index 130537724..2b589b434 100644 --- a/src/main/java/com/adyen/model/balanceplatform/PlatformPaymentConfiguration.java +++ b/src/main/java/com/adyen/model/balanceplatform/PlatformPaymentConfiguration.java @@ -63,6 +63,11 @@ public String getSalesDayClosingTime() { } + /** + * Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends. Possible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**. Default value: **\"00:00\"**. + * + * @param salesDayClosingTime + */ @JsonProperty(JSON_PROPERTY_SALES_DAY_CLOSING_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSalesDayClosingTime(String salesDayClosingTime) { @@ -88,6 +93,11 @@ public Integer getSettlementDelayDays() { } + /** + * Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available. Possible values: **0** to **10**, or **null**. * Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement). * Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement). Default value: **null**. + * + * @param settlementDelayDays + */ @JsonProperty(JSON_PROPERTY_SETTLEMENT_DELAY_DAYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSettlementDelayDays(Integer settlementDelayDays) { diff --git a/src/main/java/com/adyen/model/balanceplatform/ProcessingTypesRestriction.java b/src/main/java/com/adyen/model/balanceplatform/ProcessingTypesRestriction.java index 8a7600d76..058b8dcec 100644 --- a/src/main/java/com/adyen/model/balanceplatform/ProcessingTypesRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/ProcessingTypesRestriction.java @@ -112,6 +112,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -145,6 +150,11 @@ public List getValue() { } + /** + * List of processing types. Possible values: **atmWithdraw**, **balanceInquiry**, **ecommerce**, **moto**, **pos**, **recurring**, **token**. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(List value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/RemediatingAction.java b/src/main/java/com/adyen/model/balanceplatform/RemediatingAction.java index df34f962e..d79fe062e 100644 --- a/src/main/java/com/adyen/model/balanceplatform/RemediatingAction.java +++ b/src/main/java/com/adyen/model/balanceplatform/RemediatingAction.java @@ -63,6 +63,11 @@ public String getCode() { } + /** + * The remediating action code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -88,6 +93,11 @@ public String getMessage() { } + /** + * A description of how you can resolve the verification error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { diff --git a/src/main/java/com/adyen/model/balanceplatform/Repayment.java b/src/main/java/com/adyen/model/balanceplatform/Repayment.java index c64496ba2..7f09987e8 100644 --- a/src/main/java/com/adyen/model/balanceplatform/Repayment.java +++ b/src/main/java/com/adyen/model/balanceplatform/Repayment.java @@ -69,6 +69,11 @@ public Integer getBasisPoints() { } + /** + * The repayment that is deducted daily from incoming net volume, in [basis points](https://www.investopedia.com/terms/b/basispoint.asp). + * + * @param basisPoints + */ @JsonProperty(JSON_PROPERTY_BASIS_POINTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBasisPoints(Integer basisPoints) { @@ -94,6 +99,11 @@ public RepaymentTerm getTerm() { } + /** + * term + * + * @param term + */ @JsonProperty(JSON_PROPERTY_TERM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerm(RepaymentTerm term) { @@ -119,6 +129,11 @@ public ThresholdRepayment getThreshold() { } + /** + * threshold + * + * @param threshold + */ @JsonProperty(JSON_PROPERTY_THRESHOLD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreshold(ThresholdRepayment threshold) { diff --git a/src/main/java/com/adyen/model/balanceplatform/RepaymentTerm.java b/src/main/java/com/adyen/model/balanceplatform/RepaymentTerm.java index 9c070bae5..9f065cf4e 100644 --- a/src/main/java/com/adyen/model/balanceplatform/RepaymentTerm.java +++ b/src/main/java/com/adyen/model/balanceplatform/RepaymentTerm.java @@ -63,6 +63,11 @@ public Integer getEstimatedDays() { } + /** + * The estimated term for repaying the grant, in days. + * + * @param estimatedDays + */ @JsonProperty(JSON_PROPERTY_ESTIMATED_DAYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEstimatedDays(Integer estimatedDays) { @@ -88,6 +93,11 @@ public Integer getMaximumDays() { } + /** + * The maximum term for repaying the grant, in days. Only applies when `contractType` is **loan**. + * + * @param maximumDays + */ @JsonProperty(JSON_PROPERTY_MAXIMUM_DAYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaximumDays(Integer maximumDays) { diff --git a/src/main/java/com/adyen/model/balanceplatform/RestServiceError.java b/src/main/java/com/adyen/model/balanceplatform/RestServiceError.java index 00b6662ff..9040f13b6 100644 --- a/src/main/java/com/adyen/model/balanceplatform/RestServiceError.java +++ b/src/main/java/com/adyen/model/balanceplatform/RestServiceError.java @@ -94,6 +94,11 @@ public String getDetail() { } + /** + * A human-readable explanation specific to this occurrence of the problem. + * + * @param detail + */ @JsonProperty(JSON_PROPERTY_DETAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetail(String detail) { @@ -119,6 +124,11 @@ public String getErrorCode() { } + /** + * A code that identifies the problem type. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -144,6 +154,11 @@ public String getInstance() { } + /** + * A unique URI that identifies the specific occurrence of the problem. + * + * @param instance + */ @JsonProperty(JSON_PROPERTY_INSTANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstance(String instance) { @@ -177,6 +192,11 @@ public List getInvalidFields() { } + /** + * Detailed explanation of each validation error, when applicable. + * + * @param invalidFields + */ @JsonProperty(JSON_PROPERTY_INVALID_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvalidFields(List invalidFields) { @@ -202,6 +222,11 @@ public String getRequestId() { } + /** + * A unique reference for the request, essentially the same as `pspReference`. + * + * @param requestId + */ @JsonProperty(JSON_PROPERTY_REQUEST_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestId(String requestId) { @@ -227,6 +252,11 @@ public Object getResponse() { } + /** + * response + * + * @param response + */ @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponse(Object response) { @@ -252,6 +282,11 @@ public Integer getStatus() { } + /** + * The HTTP status code. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { @@ -277,6 +312,11 @@ public String getTitle() { } + /** + * A short, human-readable summary of the problem type. + * + * @param title + */ @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTitle(String title) { @@ -302,6 +342,11 @@ public String getType() { } + /** + * A URI that identifies the problem type, pointing to human-readable documentation on this problem type. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SELocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/SELocalAccountIdentification.java index 73adfd93f..b44663913 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SELocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/SELocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingNumber() { } + /** + * The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. + * + * @param clearingNumber + */ @JsonProperty(JSON_PROPERTY_CLEARING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingNumber(String clearingNumber) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **seLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SGLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/SGLocalAccountIdentification.java index 0b8cfdaee..9fe93ab73 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SGLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/SGLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4- to 19-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **sgLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SameAmountRestriction.java b/src/main/java/com/adyen/model/balanceplatform/SameAmountRestriction.java index ade7f2bc7..983e58a3d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SameAmountRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/SameAmountRestriction.java @@ -63,6 +63,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -88,6 +93,11 @@ public Boolean getValue() { } + /** + * value + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Boolean value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SameCounterpartyRestriction.java b/src/main/java/com/adyen/model/balanceplatform/SameCounterpartyRestriction.java index b9c5dd037..10417a4b7 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SameCounterpartyRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/SameCounterpartyRestriction.java @@ -63,6 +63,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -88,6 +93,11 @@ public Boolean getValue() { } + /** + * value + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Boolean value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/StringMatch.java b/src/main/java/com/adyen/model/balanceplatform/StringMatch.java index 9af8fda74..23da3afb6 100644 --- a/src/main/java/com/adyen/model/balanceplatform/StringMatch.java +++ b/src/main/java/com/adyen/model/balanceplatform/StringMatch.java @@ -102,6 +102,11 @@ public OperationEnum getOperation() { } + /** + * The type of string matching operation. Possible values: **startsWith**, **endsWith**, **isEqualTo**, **contains**, + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(OperationEnum operation) { @@ -127,6 +132,11 @@ public String getValue() { } + /** + * The string to be matched. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(String value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SweepConfigurationV2.java b/src/main/java/com/adyen/model/balanceplatform/SweepConfigurationV2.java index 9577448f2..8b9c51ae6 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SweepConfigurationV2.java +++ b/src/main/java/com/adyen/model/balanceplatform/SweepConfigurationV2.java @@ -325,6 +325,11 @@ public CategoryEnum getCategory() { } + /** + * The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -350,6 +355,11 @@ public SweepCounterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(SweepCounterparty counterparty) { @@ -375,6 +385,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -400,6 +415,11 @@ public String getDescription() { } + /** + * The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -425,6 +445,11 @@ public String getId() { } + /** + * The unique identifier of the sweep. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -458,6 +483,11 @@ public List getPriorities() { } + /** + * The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that's not possible, it moves on to the next option in the order of provided priorities. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup). + * + * @param priorities + */ @JsonProperty(JSON_PROPERTY_PRIORITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriorities(List priorities) { @@ -483,6 +513,11 @@ public ReasonEnum getReason() { } + /** + * The reason for disabling the sweep. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -508,6 +543,11 @@ public SweepSchedule getSchedule() { } + /** + * schedule + * + * @param schedule + */ @JsonProperty(JSON_PROPERTY_SCHEDULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSchedule(SweepSchedule schedule) { @@ -533,6 +573,11 @@ public StatusEnum getStatus() { } + /** + * The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -558,6 +603,11 @@ public Amount getSweepAmount() { } + /** + * sweepAmount + * + * @param sweepAmount + */ @JsonProperty(JSON_PROPERTY_SWEEP_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSweepAmount(Amount sweepAmount) { @@ -583,6 +633,11 @@ public Amount getTargetAmount() { } + /** + * targetAmount + * + * @param targetAmount + */ @JsonProperty(JSON_PROPERTY_TARGET_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTargetAmount(Amount targetAmount) { @@ -608,6 +663,11 @@ public Amount getTriggerAmount() { } + /** + * triggerAmount + * + * @param triggerAmount + */ @JsonProperty(JSON_PROPERTY_TRIGGER_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTriggerAmount(Amount triggerAmount) { @@ -633,6 +693,11 @@ public TypeEnum getType() { } + /** + * The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SweepCounterparty.java b/src/main/java/com/adyen/model/balanceplatform/SweepCounterparty.java index 0420c0149..217e9990a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SweepCounterparty.java +++ b/src/main/java/com/adyen/model/balanceplatform/SweepCounterparty.java @@ -67,6 +67,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). You can only use this for periodic sweep schedules such as `schedule.type` **daily** or **monthly**. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -92,6 +97,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and `schedule.type` **balance**, and if you are processing payments with Adyen. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -117,6 +127,11 @@ public String getTransferInstrumentId() { } + /** + * The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To [set up automated top-up sweeps to balance accounts](https://docs.adyen.com/marketplaces-and-platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature. + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/balanceplatform/SweepSchedule.java b/src/main/java/com/adyen/model/balanceplatform/SweepSchedule.java index 70c777043..d0fc65383 100644 --- a/src/main/java/com/adyen/model/balanceplatform/SweepSchedule.java +++ b/src/main/java/com/adyen/model/balanceplatform/SweepSchedule.java @@ -104,6 +104,11 @@ public String getCronExpression() { } + /** + * A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, **30 17 * * MON** schedules a sweep every Monday at 17:30. The expression must have five values separated by a single space in the following order: * Minute: **0-59** * Hour: **0-23** * Day of the month: **1-31** * Month: **1-12** or **JAN-DEC** * Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**. The following non-standard characters are supported: *****, **L**, **#**, **W** and **_/_**. See [crontab guru](https://crontab.guru/) for more examples. Required when `type` is **cron**. + * + * @param cronExpression + */ @JsonProperty(JSON_PROPERTY_CRON_EXPRESSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCronExpression(String cronExpression) { @@ -129,6 +134,11 @@ public TypeEnum getType() { } + /** + * The schedule type. Possible values: * **cron**: push out funds based on a `cronExpression`. * **daily**: push out funds daily at 07:00 AM CET. * **weekly**: push out funds every Monday at 07:00 AM CET. * **monthly**: push out funds every first of the month at 07:00 AM CET. * **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`. If the source is transferInstrument, merchant account identifier is still required, with which you want to process the transaction. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/ThresholdRepayment.java b/src/main/java/com/adyen/model/balanceplatform/ThresholdRepayment.java index 7a497efde..7c4082e9b 100644 --- a/src/main/java/com/adyen/model/balanceplatform/ThresholdRepayment.java +++ b/src/main/java/com/adyen/model/balanceplatform/ThresholdRepayment.java @@ -60,6 +60,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TimeOfDay.java b/src/main/java/com/adyen/model/balanceplatform/TimeOfDay.java index 40ad5177a..ab6a91d9b 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TimeOfDay.java +++ b/src/main/java/com/adyen/model/balanceplatform/TimeOfDay.java @@ -63,6 +63,11 @@ public String getEndTime() { } + /** + * The end time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**. + * + * @param endTime + */ @JsonProperty(JSON_PROPERTY_END_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEndTime(String endTime) { @@ -88,6 +93,11 @@ public String getStartTime() { } + /** + * The start time in a time-only ISO-8601 extended offset format. For example: **08:00:00+02:00**, **22:30:00-03:00**. + * + * @param startTime + */ @JsonProperty(JSON_PROPERTY_START_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartTime(String startTime) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TimeOfDayRestriction.java b/src/main/java/com/adyen/model/balanceplatform/TimeOfDayRestriction.java index 583fe7cd6..af3cb10f3 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TimeOfDayRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/TimeOfDayRestriction.java @@ -64,6 +64,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -89,6 +94,11 @@ public TimeOfDay getValue() { } + /** + * value + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(TimeOfDay value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TotalAmountRestriction.java b/src/main/java/com/adyen/model/balanceplatform/TotalAmountRestriction.java index 1826b9b2c..1b1fa9307 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TotalAmountRestriction.java +++ b/src/main/java/com/adyen/model/balanceplatform/TotalAmountRestriction.java @@ -64,6 +64,11 @@ public String getOperation() { } + /** + * Defines how the condition must be evaluated. + * + * @param operation + */ @JsonProperty(JSON_PROPERTY_OPERATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOperation(String operation) { @@ -89,6 +94,11 @@ public Amount getValue() { } + /** + * value + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Amount value) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRule.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRule.java index 162ca5092..0c0cb6ad6 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRule.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRule.java @@ -264,6 +264,11 @@ public String getAggregationLevel() { } + /** + * The level at which data must be accumulated, used in rules with `type` **velocity** or **maxUsage**. The level must be the [same or lower in hierarchy](https://docs.adyen.com/issuing/transaction-rules#accumulate-data) than the `entityKey`. If not provided, by default, the rule will accumulate data at the **paymentInstrument** level. Possible values: **paymentInstrument**, **paymentInstrumentGroup**, **balanceAccount**, **accountHolder**, **balancePlatform**. + * + * @param aggregationLevel + */ @JsonProperty(JSON_PROPERTY_AGGREGATION_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAggregationLevel(String aggregationLevel) { @@ -289,6 +294,11 @@ public String getDescription() { } + /** + * Your description for the transaction rule, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -314,6 +324,11 @@ public String getEndDate() { } + /** + * The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**. If not provided, the rule will be evaluated until the rule status is set to **inactive**. + * + * @param endDate + */ @JsonProperty(JSON_PROPERTY_END_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEndDate(String endDate) { @@ -339,6 +354,11 @@ public TransactionRuleEntityKey getEntityKey() { } + /** + * entityKey + * + * @param entityKey + */ @JsonProperty(JSON_PROPERTY_ENTITY_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityKey(TransactionRuleEntityKey entityKey) { @@ -364,6 +384,11 @@ public String getId() { } + /** + * The unique identifier of the transaction rule. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -389,6 +414,11 @@ public TransactionRuleInterval getInterval() { } + /** + * interval + * + * @param interval + */ @JsonProperty(JSON_PROPERTY_INTERVAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterval(TransactionRuleInterval interval) { @@ -414,6 +444,11 @@ public OutcomeTypeEnum getOutcomeType() { } + /** + * The [outcome](https://docs.adyen.com/issuing/transaction-rules#outcome) that will be applied when a transaction meets the conditions of the rule. If not provided, by default, this is set to **hardBlock**. Possible values: * **hardBlock**: the transaction is declined. * **scoreBased**: the transaction is assigned the `score` you specified. Adyen calculates the total score and if it exceeds 100, the transaction is declined. + * + * @param outcomeType + */ @JsonProperty(JSON_PROPERTY_OUTCOME_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOutcomeType(OutcomeTypeEnum outcomeType) { @@ -439,6 +474,11 @@ public String getReference() { } + /** + * Your reference for the transaction rule, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -464,6 +504,11 @@ public RequestTypeEnum getRequestType() { } + /** + * Indicates the type of request to which the rule applies. If not provided, by default, this is set to **authorization**. Possible values: **authorization**, **authentication**, **tokenization**, **bankTransfer**. + * + * @param requestType + */ @JsonProperty(JSON_PROPERTY_REQUEST_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestType(RequestTypeEnum requestType) { @@ -489,6 +534,11 @@ public TransactionRuleRestrictions getRuleRestrictions() { } + /** + * ruleRestrictions + * + * @param ruleRestrictions + */ @JsonProperty(JSON_PROPERTY_RULE_RESTRICTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRuleRestrictions(TransactionRuleRestrictions ruleRestrictions) { @@ -514,6 +564,11 @@ public Integer getScore() { } + /** + * A positive or negative score applied to the transaction if it meets the conditions of the rule. Required when `outcomeType` is **scoreBased**. The value must be between **-100** and **100**. + * + * @param score + */ @JsonProperty(JSON_PROPERTY_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScore(Integer score) { @@ -539,6 +594,11 @@ public String getStartDate() { } + /** + * The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**. If not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to **active**. + * + * @param startDate + */ @JsonProperty(JSON_PROPERTY_START_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartDate(String startDate) { @@ -564,6 +624,11 @@ public StatusEnum getStatus() { } + /** + * The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created with an **active** status. Possible values: **active**, **inactive**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -589,6 +654,11 @@ public TypeEnum getType() { } + /** + * The [type of rule](https://docs.adyen.com/issuing/transaction-rules#rule-types), which defines if a rule blocks transactions based on individual characteristics or accumulates data. Possible values: * **blockList**: decline a transaction when the conditions are met. * **maxUsage**: add the amount or number of transactions for the lifetime of a payment instrument, and then decline a transaction when the specified limits are met. * **velocity**: add the amount or number of transactions based on a specified time interval, and then decline a transaction when the specified limits are met. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleEntityKey.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleEntityKey.java index 7c9cc5973..e3c5d9870 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleEntityKey.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleEntityKey.java @@ -63,6 +63,11 @@ public String getEntityReference() { } + /** + * The unique identifier of the resource. + * + * @param entityReference + */ @JsonProperty(JSON_PROPERTY_ENTITY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityReference(String entityReference) { @@ -88,6 +93,11 @@ public String getEntityType() { } + /** + * The type of resource. Possible values: **balancePlatform**, **paymentInstrumentGroup**, **accountHolder**, **balanceAccount**, or **paymentInstrument**. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(String entityType) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInfo.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInfo.java index 6cb8e0aa6..ebf297838 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInfo.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInfo.java @@ -260,6 +260,11 @@ public String getAggregationLevel() { } + /** + * The level at which data must be accumulated, used in rules with `type` **velocity** or **maxUsage**. The level must be the [same or lower in hierarchy](https://docs.adyen.com/issuing/transaction-rules#accumulate-data) than the `entityKey`. If not provided, by default, the rule will accumulate data at the **paymentInstrument** level. Possible values: **paymentInstrument**, **paymentInstrumentGroup**, **balanceAccount**, **accountHolder**, **balancePlatform**. + * + * @param aggregationLevel + */ @JsonProperty(JSON_PROPERTY_AGGREGATION_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAggregationLevel(String aggregationLevel) { @@ -285,6 +290,11 @@ public String getDescription() { } + /** + * Your description for the transaction rule, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -310,6 +320,11 @@ public String getEndDate() { } + /** + * The date when the rule will stop being evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**. If not provided, the rule will be evaluated until the rule status is set to **inactive**. + * + * @param endDate + */ @JsonProperty(JSON_PROPERTY_END_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEndDate(String endDate) { @@ -335,6 +350,11 @@ public TransactionRuleEntityKey getEntityKey() { } + /** + * entityKey + * + * @param entityKey + */ @JsonProperty(JSON_PROPERTY_ENTITY_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityKey(TransactionRuleEntityKey entityKey) { @@ -360,6 +380,11 @@ public TransactionRuleInterval getInterval() { } + /** + * interval + * + * @param interval + */ @JsonProperty(JSON_PROPERTY_INTERVAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterval(TransactionRuleInterval interval) { @@ -385,6 +410,11 @@ public OutcomeTypeEnum getOutcomeType() { } + /** + * The [outcome](https://docs.adyen.com/issuing/transaction-rules#outcome) that will be applied when a transaction meets the conditions of the rule. If not provided, by default, this is set to **hardBlock**. Possible values: * **hardBlock**: the transaction is declined. * **scoreBased**: the transaction is assigned the `score` you specified. Adyen calculates the total score and if it exceeds 100, the transaction is declined. + * + * @param outcomeType + */ @JsonProperty(JSON_PROPERTY_OUTCOME_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOutcomeType(OutcomeTypeEnum outcomeType) { @@ -410,6 +440,11 @@ public String getReference() { } + /** + * Your reference for the transaction rule, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -435,6 +470,11 @@ public RequestTypeEnum getRequestType() { } + /** + * Indicates the type of request to which the rule applies. If not provided, by default, this is set to **authorization**. Possible values: **authorization**, **authentication**, **tokenization**, **bankTransfer**. + * + * @param requestType + */ @JsonProperty(JSON_PROPERTY_REQUEST_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestType(RequestTypeEnum requestType) { @@ -460,6 +500,11 @@ public TransactionRuleRestrictions getRuleRestrictions() { } + /** + * ruleRestrictions + * + * @param ruleRestrictions + */ @JsonProperty(JSON_PROPERTY_RULE_RESTRICTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRuleRestrictions(TransactionRuleRestrictions ruleRestrictions) { @@ -485,6 +530,11 @@ public Integer getScore() { } + /** + * A positive or negative score applied to the transaction if it meets the conditions of the rule. Required when `outcomeType` is **scoreBased**. The value must be between **-100** and **100**. + * + * @param score + */ @JsonProperty(JSON_PROPERTY_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScore(Integer score) { @@ -510,6 +560,11 @@ public String getStartDate() { } + /** + * The date when the rule will start to be evaluated, in ISO 8601 extended offset date-time format. For example, **2020-12-18T10:15:30+01:00**. If not provided when creating a transaction rule, the `startDate` is set to the date when the rule status is set to **active**. + * + * @param startDate + */ @JsonProperty(JSON_PROPERTY_START_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartDate(String startDate) { @@ -535,6 +590,11 @@ public StatusEnum getStatus() { } + /** + * The status of the transaction rule. If you provide a `startDate` in the request, the rule is automatically created with an **active** status. Possible values: **active**, **inactive**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -560,6 +620,11 @@ public TypeEnum getType() { } + /** + * The [type of rule](https://docs.adyen.com/issuing/transaction-rules#rule-types), which defines if a rule blocks transactions based on individual characteristics or accumulates data. Possible values: * **blockList**: decline a transaction when the conditions are met. * **maxUsage**: add the amount or number of transactions for the lifetime of a payment instrument, and then decline a transaction when the specified limits are met. * **velocity**: add the amount or number of transactions based on a specified time interval, and then decline a transaction when the specified limits are met. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInterval.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInterval.java index dce1499ac..e904de9f0 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInterval.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleInterval.java @@ -170,6 +170,11 @@ public Integer getDayOfMonth() { } + /** + * The day of month, used when the `duration.unit` is **months**. If not provided, by default, this is set to **1**, the first day of the month. + * + * @param dayOfMonth + */ @JsonProperty(JSON_PROPERTY_DAY_OF_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDayOfMonth(Integer dayOfMonth) { @@ -195,6 +200,11 @@ public DayOfWeekEnum getDayOfWeek() { } + /** + * The day of week, used when the `duration.unit` is **weeks**. If not provided, by default, this is set to **monday**. Possible values: **sunday**, **monday**, **tuesday**, **wednesday**, **thursday**, **friday**. + * + * @param dayOfWeek + */ @JsonProperty(JSON_PROPERTY_DAY_OF_WEEK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDayOfWeek(DayOfWeekEnum dayOfWeek) { @@ -220,6 +230,11 @@ public Duration getDuration() { } + /** + * duration + * + * @param duration + */ @JsonProperty(JSON_PROPERTY_DURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDuration(Duration duration) { @@ -245,6 +260,11 @@ public String getTimeOfDay() { } + /** + * The time of day, in **hh:mm:ss** format, used when the `duration.unit` is **hours**. If not provided, by default, this is set to **00:00:00**. + * + * @param timeOfDay + */ @JsonProperty(JSON_PROPERTY_TIME_OF_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeOfDay(String timeOfDay) { @@ -270,6 +290,11 @@ public String getTimeZone() { } + /** + * The [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For example, **Europe/Amsterdam**. By default, this is set to **UTC**. + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { @@ -295,6 +320,11 @@ public TypeEnum getType() { } + /** + * The [type of interval](https://docs.adyen.com/issuing/transaction-rules#time-intervals) during which the rule conditions and limits apply, and how often counters are reset. Possible values: * **perTransaction**: conditions are evaluated and the counters are reset for every transaction. * **daily**: the counters are reset daily at 00:00:00 UTC. * **weekly**: the counters are reset every Monday at 00:00:00 UTC. * **monthly**: the counters reset every first day of the month at 00:00:00 UTC. * **lifetime**: conditions are applied to the lifetime of the payment instrument. * **rolling**: conditions are applied and the counters are reset based on a `duration`. If the reset date and time are not provided, Adyen applies the default reset time similar to fixed intervals. For example, if the duration is every two weeks, the counter resets every third Monday at 00:00:00 UTC. * **sliding**: conditions are applied and the counters are reset based on the current time and a `duration` that you specify. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleResponse.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleResponse.java index d9d9a372b..0371a7847 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleResponse.java @@ -60,6 +60,11 @@ public TransactionRule getTransactionRule() { } + /** + * transactionRule + * + * @param transactionRule + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionRule(TransactionRule transactionRule) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleRestrictions.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleRestrictions.java index d20fc620c..5219eaa59 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRuleRestrictions.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRuleRestrictions.java @@ -140,6 +140,11 @@ public ActiveNetworkTokensRestriction getActiveNetworkTokens() { } + /** + * activeNetworkTokens + * + * @param activeNetworkTokens + */ @JsonProperty(JSON_PROPERTY_ACTIVE_NETWORK_TOKENS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActiveNetworkTokens(ActiveNetworkTokensRestriction activeNetworkTokens) { @@ -165,6 +170,11 @@ public BrandVariantsRestriction getBrandVariants() { } + /** + * brandVariants + * + * @param brandVariants + */ @JsonProperty(JSON_PROPERTY_BRAND_VARIANTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrandVariants(BrandVariantsRestriction brandVariants) { @@ -190,6 +200,11 @@ public CounterpartyBankRestriction getCounterpartyBank() { } + /** + * counterpartyBank + * + * @param counterpartyBank + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterpartyBank(CounterpartyBankRestriction counterpartyBank) { @@ -215,6 +230,11 @@ public CountriesRestriction getCountries() { } + /** + * countries + * + * @param countries + */ @JsonProperty(JSON_PROPERTY_COUNTRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountries(CountriesRestriction countries) { @@ -240,6 +260,11 @@ public DayOfWeekRestriction getDayOfWeek() { } + /** + * dayOfWeek + * + * @param dayOfWeek + */ @JsonProperty(JSON_PROPERTY_DAY_OF_WEEK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDayOfWeek(DayOfWeekRestriction dayOfWeek) { @@ -265,6 +290,11 @@ public DifferentCurrenciesRestriction getDifferentCurrencies() { } + /** + * differentCurrencies + * + * @param differentCurrencies + */ @JsonProperty(JSON_PROPERTY_DIFFERENT_CURRENCIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDifferentCurrencies(DifferentCurrenciesRestriction differentCurrencies) { @@ -290,6 +320,11 @@ public EntryModesRestriction getEntryModes() { } + /** + * entryModes + * + * @param entryModes + */ @JsonProperty(JSON_PROPERTY_ENTRY_MODES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntryModes(EntryModesRestriction entryModes) { @@ -315,6 +350,11 @@ public InternationalTransactionRestriction getInternationalTransaction() { } + /** + * internationalTransaction + * + * @param internationalTransaction + */ @JsonProperty(JSON_PROPERTY_INTERNATIONAL_TRANSACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInternationalTransaction(InternationalTransactionRestriction internationalTransaction) { @@ -340,6 +380,11 @@ public MatchingTransactionsRestriction getMatchingTransactions() { } + /** + * matchingTransactions + * + * @param matchingTransactions + */ @JsonProperty(JSON_PROPERTY_MATCHING_TRANSACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMatchingTransactions(MatchingTransactionsRestriction matchingTransactions) { @@ -365,6 +410,11 @@ public MccsRestriction getMccs() { } + /** + * mccs + * + * @param mccs + */ @JsonProperty(JSON_PROPERTY_MCCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMccs(MccsRestriction mccs) { @@ -390,6 +440,11 @@ public MerchantNamesRestriction getMerchantNames() { } + /** + * merchantNames + * + * @param merchantNames + */ @JsonProperty(JSON_PROPERTY_MERCHANT_NAMES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantNames(MerchantNamesRestriction merchantNames) { @@ -415,6 +470,11 @@ public MerchantsRestriction getMerchants() { } + /** + * merchants + * + * @param merchants + */ @JsonProperty(JSON_PROPERTY_MERCHANTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchants(MerchantsRestriction merchants) { @@ -440,6 +500,11 @@ public ProcessingTypesRestriction getProcessingTypes() { } + /** + * processingTypes + * + * @param processingTypes + */ @JsonProperty(JSON_PROPERTY_PROCESSING_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProcessingTypes(ProcessingTypesRestriction processingTypes) { @@ -465,6 +530,11 @@ public SameAmountRestriction getSameAmountRestriction() { } + /** + * sameAmountRestriction + * + * @param sameAmountRestriction + */ @JsonProperty(JSON_PROPERTY_SAME_AMOUNT_RESTRICTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSameAmountRestriction(SameAmountRestriction sameAmountRestriction) { @@ -490,6 +560,11 @@ public SameCounterpartyRestriction getSameCounterpartyRestriction() { } + /** + * sameCounterpartyRestriction + * + * @param sameCounterpartyRestriction + */ @JsonProperty(JSON_PROPERTY_SAME_COUNTERPARTY_RESTRICTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSameCounterpartyRestriction(SameCounterpartyRestriction sameCounterpartyRestriction) { @@ -515,6 +590,11 @@ public TimeOfDayRestriction getTimeOfDay() { } + /** + * timeOfDay + * + * @param timeOfDay + */ @JsonProperty(JSON_PROPERTY_TIME_OF_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeOfDay(TimeOfDayRestriction timeOfDay) { @@ -540,6 +620,11 @@ public TotalAmountRestriction getTotalAmount() { } + /** + * totalAmount + * + * @param totalAmount + */ @JsonProperty(JSON_PROPERTY_TOTAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalAmount(TotalAmountRestriction totalAmount) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransactionRulesResponse.java b/src/main/java/com/adyen/model/balanceplatform/TransactionRulesResponse.java index feeba233f..c86e8ce19 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransactionRulesResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransactionRulesResponse.java @@ -70,6 +70,11 @@ public List getTransactionRules() { } + /** + * List of transaction rules. + * + * @param transactionRules + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionRules(List transactionRules) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransferRoute.java b/src/main/java/com/adyen/model/balanceplatform/TransferRoute.java index e93a94656..5b75d02e8 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransferRoute.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransferRoute.java @@ -168,6 +168,11 @@ public CategoryEnum getCategory() { } + /** + * The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -193,6 +198,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -218,6 +228,11 @@ public String getCurrency() { } + /** + * The three-character ISO currency code of transfer. For example, **USD** or **EUR**. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -243,6 +258,11 @@ public PriorityEnum getPriority() { } + /** + * The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). + * + * @param priority + */ @JsonProperty(JSON_PROPERTY_PRIORITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriority(PriorityEnum priority) { @@ -268,6 +288,11 @@ public TransferRouteRequirements getRequirements() { } + /** + * requirements + * + * @param requirements + */ @JsonProperty(JSON_PROPERTY_REQUIREMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequirements(TransferRouteRequirements requirements) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransferRouteRequest.java b/src/main/java/com/adyen/model/balanceplatform/TransferRouteRequest.java index 45e2c8a35..14893cb9d 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransferRouteRequest.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransferRouteRequest.java @@ -162,6 +162,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). Required if `counterparty` is **transferInstrumentId**. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -187,6 +192,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier assigned to the balance platform associated with the account holder. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -212,6 +222,11 @@ public CategoryEnum getCategory() { } + /** + * The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -237,6 +252,11 @@ public Counterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(Counterparty counterparty) { @@ -262,6 +282,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code of the counterparty. For example, **US** or **NL**. > Either `counterparty` or `country` field must be provided in a transfer route request. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -287,6 +312,11 @@ public String getCurrency() { } + /** + * The three-character ISO currency code of transfer. For example, **USD** or **EUR**. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -320,6 +350,11 @@ public List getPriorities() { } + /** + * The list of priorities for the bank transfer. Priorities set the speed at which the transfer is sent and the fees that you have to pay. Multiple values can be provided. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). + * + * @param priorities + */ @JsonProperty(JSON_PROPERTY_PRIORITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriorities(List priorities) { diff --git a/src/main/java/com/adyen/model/balanceplatform/TransferRouteResponse.java b/src/main/java/com/adyen/model/balanceplatform/TransferRouteResponse.java index d6873172b..91d22bc4f 100644 --- a/src/main/java/com/adyen/model/balanceplatform/TransferRouteResponse.java +++ b/src/main/java/com/adyen/model/balanceplatform/TransferRouteResponse.java @@ -70,6 +70,11 @@ public List getTransferRoutes() { } + /** + * List of available priorities for a transfer, along with requirements. Use this information to initiate a transfer. + * + * @param transferRoutes + */ @JsonProperty(JSON_PROPERTY_TRANSFER_ROUTES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferRoutes(List transferRoutes) { diff --git a/src/main/java/com/adyen/model/balanceplatform/UKLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/UKLocalAccountIdentification.java index a4d93cf01..44fa133f1 100644 --- a/src/main/java/com/adyen/model/balanceplatform/UKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/UKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 8-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getSortCode() { } + /** + * The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. + * + * @param sortCode + */ @JsonProperty(JSON_PROPERTY_SORT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSortCode(String sortCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **ukLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/USLocalAccountIdentification.java b/src/main/java/com/adyen/model/balanceplatform/USLocalAccountIdentification.java index 4e15a49f2..0c887a172 100644 --- a/src/main/java/com/adyen/model/balanceplatform/USLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/balanceplatform/USLocalAccountIdentification.java @@ -139,6 +139,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -164,6 +169,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -189,6 +199,11 @@ public String getRoutingNumber() { } + /** + * The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. + * + * @param routingNumber + */ @JsonProperty(JSON_PROPERTY_ROUTING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoutingNumber(String routingNumber) { @@ -214,6 +229,11 @@ public TypeEnum getType() { } + /** + * **usLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/UpdateNetworkTokenRequest.java b/src/main/java/com/adyen/model/balanceplatform/UpdateNetworkTokenRequest.java index e03021085..bc7d0b5c3 100644 --- a/src/main/java/com/adyen/model/balanceplatform/UpdateNetworkTokenRequest.java +++ b/src/main/java/com/adyen/model/balanceplatform/UpdateNetworkTokenRequest.java @@ -96,6 +96,11 @@ public StatusEnum getStatus() { } + /** + * The new status of the network token. Possible values: **active**, **suspended**, **closed**. The **closed** status is final and cannot be changed. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/balanceplatform/UpdatePaymentInstrument.java b/src/main/java/com/adyen/model/balanceplatform/UpdatePaymentInstrument.java index 018dd3567..3491eb190 100644 --- a/src/main/java/com/adyen/model/balanceplatform/UpdatePaymentInstrument.java +++ b/src/main/java/com/adyen/model/balanceplatform/UpdatePaymentInstrument.java @@ -228,6 +228,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -253,6 +258,11 @@ public PaymentInstrumentBankAccount getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(PaymentInstrumentBankAccount bankAccount) { @@ -278,6 +288,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -303,6 +318,11 @@ public String getDescription() { } + /** + * Your description for the payment instrument, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -328,6 +348,11 @@ public String getId() { } + /** + * The unique identifier of the payment instrument. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -353,6 +378,11 @@ public String getIssuingCountryCode() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. + * + * @param issuingCountryCode + */ @JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCountryCode(String issuingCountryCode) { @@ -378,6 +408,11 @@ public String getPaymentInstrumentGroupId() { } + /** + * The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. + * + * @param paymentInstrumentGroupId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentGroupId(String paymentInstrumentGroupId) { @@ -403,6 +438,11 @@ public String getReference() { } + /** + * Your reference for the payment instrument, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -428,6 +468,11 @@ public StatusEnum getStatus() { } + /** + * The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **inactive**. Possible values: * **active**: The payment instrument is active and can be used to make payments. * **inactive**: The payment instrument is inactive and cannot be used to make payments. * **suspended**: The payment instrument is suspended, either because it was stolen or lost. * **closed**: The payment instrument is permanently closed. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -453,6 +498,11 @@ public String getStatusComment() { } + /** + * Comment for the status of the payment instrument. Required if `statusReason` is **other**. + * + * @param statusComment + */ @JsonProperty(JSON_PROPERTY_STATUS_COMMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatusComment(String statusComment) { @@ -478,6 +528,11 @@ public StatusReasonEnum getStatusReason() { } + /** + * The reason for the status of the payment instrument. Possible values: **accountClosure**, **damaged**, **endOfLife**, **expired**, **lost**, **stolen**, **suspectedFraud**, **transactionRule**, **other**. If the reason is **other**, you must also send the `statusComment` parameter describing the status change. + * + * @param statusReason + */ @JsonProperty(JSON_PROPERTY_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatusReason(StatusReasonEnum statusReason) { @@ -503,6 +558,11 @@ public TypeEnum getType() { } + /** + * Type of payment instrument. Possible value: **card**, **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/UpdateSweepConfigurationV2.java b/src/main/java/com/adyen/model/balanceplatform/UpdateSweepConfigurationV2.java index ab4e0e08b..d1ca9e296 100644 --- a/src/main/java/com/adyen/model/balanceplatform/UpdateSweepConfigurationV2.java +++ b/src/main/java/com/adyen/model/balanceplatform/UpdateSweepConfigurationV2.java @@ -325,6 +325,11 @@ public CategoryEnum getCategory() { } + /** + * The type of transfer that results from the sweep. Possible values: - **bank**: Sweep to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. Required when setting `priorities`. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -350,6 +355,11 @@ public SweepCounterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(SweepCounterparty counterparty) { @@ -375,6 +385,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -400,6 +415,11 @@ public String getDescription() { } + /** + * The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -425,6 +445,11 @@ public String getId() { } + /** + * The unique identifier of the sweep. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -458,6 +483,11 @@ public List getPriorities() { } + /** + * The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities. Adyen will try to pay out using the priority listed first, and if that's not possible, it moves on to the next option in the order of provided priorities. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). Set `category` to **bank**. For more details, see [optional priorities setup](https://docs.adyen.com/marketplaces-and-platforms/payout-to-users/scheduled-payouts#optional-priorities-setup). + * + * @param priorities + */ @JsonProperty(JSON_PROPERTY_PRIORITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriorities(List priorities) { @@ -483,6 +513,11 @@ public ReasonEnum getReason() { } + /** + * The reason for disabling the sweep. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -508,6 +543,11 @@ public SweepSchedule getSchedule() { } + /** + * schedule + * + * @param schedule + */ @JsonProperty(JSON_PROPERTY_SCHEDULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSchedule(SweepSchedule schedule) { @@ -533,6 +573,11 @@ public StatusEnum getStatus() { } + /** + * The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -558,6 +603,11 @@ public Amount getSweepAmount() { } + /** + * sweepAmount + * + * @param sweepAmount + */ @JsonProperty(JSON_PROPERTY_SWEEP_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSweepAmount(Amount sweepAmount) { @@ -583,6 +633,11 @@ public Amount getTargetAmount() { } + /** + * targetAmount + * + * @param targetAmount + */ @JsonProperty(JSON_PROPERTY_TARGET_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTargetAmount(Amount targetAmount) { @@ -608,6 +663,11 @@ public Amount getTriggerAmount() { } + /** + * triggerAmount + * + * @param triggerAmount + */ @JsonProperty(JSON_PROPERTY_TRIGGER_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTriggerAmount(Amount triggerAmount) { @@ -633,6 +693,11 @@ public TypeEnum getType() { } + /** + * The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/VerificationDeadline.java b/src/main/java/com/adyen/model/balanceplatform/VerificationDeadline.java index c838376e0..4bdd5416c 100644 --- a/src/main/java/com/adyen/model/balanceplatform/VerificationDeadline.java +++ b/src/main/java/com/adyen/model/balanceplatform/VerificationDeadline.java @@ -206,6 +206,11 @@ public List getCapabilities() { } + /** + * The names of the capabilities to be disallowed. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -239,6 +244,11 @@ public List getEntityIds() { } + /** + * The unique identifiers of the bank account(s) that the deadline applies to + * + * @param entityIds + */ @JsonProperty(JSON_PROPERTY_ENTITY_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityIds(List entityIds) { @@ -264,6 +274,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date that verification is due by before capabilities are disallowed. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { diff --git a/src/main/java/com/adyen/model/balanceplatform/VerificationError.java b/src/main/java/com/adyen/model/balanceplatform/VerificationError.java index 038ffa090..01961a67a 100644 --- a/src/main/java/com/adyen/model/balanceplatform/VerificationError.java +++ b/src/main/java/com/adyen/model/balanceplatform/VerificationError.java @@ -259,6 +259,11 @@ public List getCapabilities() { } + /** + * Contains the capabilities that the verification error applies to. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -284,6 +289,11 @@ public String getCode() { } + /** + * The verification error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -309,6 +319,11 @@ public String getMessage() { } + /** + * A description of the error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -342,6 +357,11 @@ public List getRemediatingActions() { } + /** + * Contains the actions that you can take to resolve the verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { @@ -375,6 +395,11 @@ public List getSubErrors() { } + /** + * Contains more granular information about the verification error. + * + * @param subErrors + */ @JsonProperty(JSON_PROPERTY_SUB_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubErrors(List subErrors) { @@ -400,6 +425,11 @@ public TypeEnum getType() { } + /** + * The type of error. Possible values: **invalidInput**, **dataMissing**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/balanceplatform/VerificationErrorRecursive.java b/src/main/java/com/adyen/model/balanceplatform/VerificationErrorRecursive.java index 8bae5b084..7caef8639 100644 --- a/src/main/java/com/adyen/model/balanceplatform/VerificationErrorRecursive.java +++ b/src/main/java/com/adyen/model/balanceplatform/VerificationErrorRecursive.java @@ -255,6 +255,11 @@ public List getCapabilities() { } + /** + * Contains the capabilities that the verification error applies to. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -280,6 +285,11 @@ public String getCode() { } + /** + * The verification error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -305,6 +315,11 @@ public String getMessage() { } + /** + * A description of the error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -330,6 +345,11 @@ public TypeEnum getType() { } + /** + * The type of error. Possible values: **invalidInput**, **dataMissing**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -363,6 +383,11 @@ public List getRemediatingActions() { } + /** + * Contains the actions that you can take to resolve the verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { diff --git a/src/main/java/com/adyen/model/binlookup/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/binlookup/AbstractOpenApiSchema.java index 70f1e8d01..103405455 100644 --- a/src/main/java/com/adyen/model/binlookup/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/binlookup/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * diff --git a/src/main/java/com/adyen/model/binlookup/Amount.java b/src/main/java/com/adyen/model/binlookup/Amount.java index 032573e2a..e06251afc 100644 --- a/src/main/java/com/adyen/model/binlookup/Amount.java +++ b/src/main/java/com/adyen/model/binlookup/Amount.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -64,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -89,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/binlookup/BinDetail.java b/src/main/java/com/adyen/model/binlookup/BinDetail.java index 12b03daaf..0b0256323 100644 --- a/src/main/java/com/adyen/model/binlookup/BinDetail.java +++ b/src/main/java/com/adyen/model/binlookup/BinDetail.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -60,6 +59,11 @@ public String getIssuerCountry() { } + /** + * The country where the card was issued. + * + * @param issuerCountry + */ @JsonProperty(JSON_PROPERTY_ISSUER_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerCountry(String issuerCountry) { diff --git a/src/main/java/com/adyen/model/binlookup/CardBin.java b/src/main/java/com/adyen/model/binlookup/CardBin.java index f29a1affd..373b381d8 100644 --- a/src/main/java/com/adyen/model/binlookup/CardBin.java +++ b/src/main/java/com/adyen/model/binlookup/CardBin.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -100,6 +99,11 @@ public String getBin() { } + /** + * The first 6 digit of the card number. Enable this field via merchant account settings. + * + * @param bin + */ @JsonProperty(JSON_PROPERTY_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBin(String bin) { @@ -125,6 +129,11 @@ public Boolean getCommercial() { } + /** + * If true, it indicates a commercial card. Enable this field via merchant account settings. + * + * @param commercial + */ @JsonProperty(JSON_PROPERTY_COMMERCIAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommercial(Boolean commercial) { @@ -150,6 +159,11 @@ public String getFundingSource() { } + /** + * The card funding source. Valid values are: * CHARGE * CREDIT * DEBIT * DEFERRED_DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE > Enable this field via merchant account settings. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(String fundingSource) { @@ -175,6 +189,11 @@ public String getFundsAvailability() { } + /** + * Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from \"N\" or \"U\". + * + * @param fundsAvailability + */ @JsonProperty(JSON_PROPERTY_FUNDS_AVAILABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundsAvailability(String fundsAvailability) { @@ -200,6 +219,11 @@ public String getIssuerBin() { } + /** + * The first 8 digit of the card number. Enable this field via merchant account settings. + * + * @param issuerBin + */ @JsonProperty(JSON_PROPERTY_ISSUER_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerBin(String issuerBin) { @@ -225,6 +249,11 @@ public String getIssuingBank() { } + /** + * The issuing bank of the card. + * + * @param issuingBank + */ @JsonProperty(JSON_PROPERTY_ISSUING_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingBank(String issuingBank) { @@ -250,6 +279,11 @@ public String getIssuingCountry() { } + /** + * The country where the card was issued from. + * + * @param issuingCountry + */ @JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCountry(String issuingCountry) { @@ -275,6 +309,11 @@ public String getIssuingCurrency() { } + /** + * The currency of the card. + * + * @param issuingCurrency + */ @JsonProperty(JSON_PROPERTY_ISSUING_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCurrency(String issuingCurrency) { @@ -300,6 +339,11 @@ public String getPaymentMethod() { } + /** + * The payment method associated with the card (e.g. visa, mc, or amex). + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -325,6 +369,11 @@ public String getPayoutEligible() { } + /** + * Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) > Returned when you verify a card BIN or estimate costs, and only if `payoutEligible` is different from \"N\" or \"U\". + * + * @param payoutEligible + */ @JsonProperty(JSON_PROPERTY_PAYOUT_ELIGIBLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayoutEligible(String payoutEligible) { @@ -350,6 +399,11 @@ public String getSummary() { } + /** + * The last four digits of the card number. + * + * @param summary + */ @JsonProperty(JSON_PROPERTY_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSummary(String summary) { diff --git a/src/main/java/com/adyen/model/binlookup/CostEstimateAssumptions.java b/src/main/java/com/adyen/model/binlookup/CostEstimateAssumptions.java index 230cc9c8a..732ad90b0 100644 --- a/src/main/java/com/adyen/model/binlookup/CostEstimateAssumptions.java +++ b/src/main/java/com/adyen/model/binlookup/CostEstimateAssumptions.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -68,6 +67,11 @@ public Boolean getAssume3DSecureAuthenticated() { } + /** + * If true, the cardholder is expected to successfully authorise via 3D Secure. + * + * @param assume3DSecureAuthenticated + */ @JsonProperty(JSON_PROPERTY_ASSUME3_D_SECURE_AUTHENTICATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssume3DSecureAuthenticated(Boolean assume3DSecureAuthenticated) { @@ -93,6 +97,11 @@ public Boolean getAssumeLevel3Data() { } + /** + * If true, the transaction is expected to have valid Level 3 data. + * + * @param assumeLevel3Data + */ @JsonProperty(JSON_PROPERTY_ASSUME_LEVEL3_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssumeLevel3Data(Boolean assumeLevel3Data) { @@ -118,6 +127,11 @@ public Integer getInstallments() { } + /** + * If not zero, the number of installments. + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Integer installments) { diff --git a/src/main/java/com/adyen/model/binlookup/CostEstimateRequest.java b/src/main/java/com/adyen/model/binlookup/CostEstimateRequest.java index a01f89e0a..a4f602eff 100644 --- a/src/main/java/com/adyen/model/binlookup/CostEstimateRequest.java +++ b/src/main/java/com/adyen/model/binlookup/CostEstimateRequest.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -139,6 +138,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -164,6 +168,11 @@ public CostEstimateAssumptions getAssumptions() { } + /** + * assumptions + * + * @param assumptions + */ @JsonProperty(JSON_PROPERTY_ASSUMPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssumptions(CostEstimateAssumptions assumptions) { @@ -189,6 +198,11 @@ public String getCardNumber() { } + /** + * The card number (4-19 characters) for PCI compliant use cases. Do not use any separators. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request. + * + * @param cardNumber + */ @JsonProperty(JSON_PROPERTY_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardNumber(String cardNumber) { @@ -214,6 +228,11 @@ public String getEncryptedCardNumber() { } + /** + * Encrypted data that stores card information for non PCI-compliant use cases. The encrypted data must be created with the Checkout Card Component or Secured Fields Component, and must contain the `encryptedCardNumber` field. > Either the `cardNumber` or `encryptedCardNumber` field must be provided in a payment request. + * + * @param encryptedCardNumber + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedCardNumber(String encryptedCardNumber) { @@ -239,6 +258,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier you want to process the (transaction) request with. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -264,6 +288,11 @@ public MerchantDetails getMerchantDetails() { } + /** + * merchantDetails + * + * @param merchantDetails + */ @JsonProperty(JSON_PROPERTY_MERCHANT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantDetails(MerchantDetails merchantDetails) { @@ -289,6 +318,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -314,6 +348,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this cost estimate. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -339,6 +378,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the card holder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -364,6 +408,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/binlookup/CostEstimateResponse.java b/src/main/java/com/adyen/model/binlookup/CostEstimateResponse.java index 9393757ad..cb0994b84 100644 --- a/src/main/java/com/adyen/model/binlookup/CostEstimateResponse.java +++ b/src/main/java/com/adyen/model/binlookup/CostEstimateResponse.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -78,6 +77,11 @@ public CardBin getCardBin() { } + /** + * cardBin + * + * @param cardBin + */ @JsonProperty(JSON_PROPERTY_CARD_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardBin(CardBin cardBin) { @@ -103,6 +107,11 @@ public Amount getCostEstimateAmount() { } + /** + * costEstimateAmount + * + * @param costEstimateAmount + */ @JsonProperty(JSON_PROPERTY_COST_ESTIMATE_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCostEstimateAmount(Amount costEstimateAmount) { @@ -128,6 +137,11 @@ public String getCostEstimateReference() { } + /** + * Adyen's 16-character reference associated with the request. + * + * @param costEstimateReference + */ @JsonProperty(JSON_PROPERTY_COST_ESTIMATE_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCostEstimateReference(String costEstimateReference) { @@ -153,6 +167,11 @@ public String getResultCode() { } + /** + * The result of the cost estimation. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(String resultCode) { @@ -178,6 +197,11 @@ public String getSurchargeType() { } + /** + * Indicates the way the charges can be passed on to the cardholder. The following values are possible: * `ZERO` - the charges are not allowed to pass on * `PASSTHROUGH` - the charges can be passed on * `UNLIMITED` - there is no limit on how much surcharge is passed on + * + * @param surchargeType + */ @JsonProperty(JSON_PROPERTY_SURCHARGE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSurchargeType(String surchargeType) { diff --git a/src/main/java/com/adyen/model/binlookup/DSPublicKeyDetail.java b/src/main/java/com/adyen/model/binlookup/DSPublicKeyDetail.java index 2c66fa3e9..d3f1cd2e2 100644 --- a/src/main/java/com/adyen/model/binlookup/DSPublicKeyDetail.java +++ b/src/main/java/com/adyen/model/binlookup/DSPublicKeyDetail.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -76,6 +75,11 @@ public String getBrand() { } + /** + * Card brand. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -101,6 +105,11 @@ public String getDirectoryServerId() { } + /** + * Directory Server (DS) identifier. + * + * @param directoryServerId + */ @JsonProperty(JSON_PROPERTY_DIRECTORY_SERVER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectoryServerId(String directoryServerId) { @@ -126,6 +135,11 @@ public String getFromSDKVersion() { } + /** + * The version of the mobile 3D Secure 2 SDK. For the possible values, refer to the versions in [Adyen 3DS2 Android](https://github.com/Adyen/adyen-3ds2-android/releases) and [Adyen 3DS2 iOS](https://github.com/Adyen/adyen-3ds2-ios/releases). + * + * @param fromSDKVersion + */ @JsonProperty(JSON_PROPERTY_FROM_S_D_K_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFromSDKVersion(String fromSDKVersion) { @@ -151,6 +165,11 @@ public byte[] getPublicKey() { } + /** + * Public key. The 3D Secure 2 SDK encrypts the device information by using the DS public key. + * + * @param publicKey + */ @JsonProperty(JSON_PROPERTY_PUBLIC_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPublicKey(byte[] publicKey) { @@ -176,6 +195,11 @@ public String getRootCertificates() { } + /** + * Directory Server root certificates. The 3D Secure 2 SDK verifies the ACS signed content using the rootCertificates. + * + * @param rootCertificates + */ @JsonProperty(JSON_PROPERTY_ROOT_CERTIFICATES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRootCertificates(String rootCertificates) { diff --git a/src/main/java/com/adyen/model/binlookup/MerchantDetails.java b/src/main/java/com/adyen/model/binlookup/MerchantDetails.java index 81969fc5c..2a400e2b9 100644 --- a/src/main/java/com/adyen/model/binlookup/MerchantDetails.java +++ b/src/main/java/com/adyen/model/binlookup/MerchantDetails.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -68,6 +67,11 @@ public String getCountryCode() { } + /** + * 2-letter ISO 3166 country code of the card acceptor location. > This parameter is required for the merchants who don't use Adyen as the payment authorisation gateway. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -93,6 +97,11 @@ public Boolean getEnrolledIn3DSecure() { } + /** + * If true, indicates that the merchant is enrolled in 3D Secure for the card network. + * + * @param enrolledIn3DSecure + */ @JsonProperty(JSON_PROPERTY_ENROLLED_IN3_D_SECURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnrolledIn3DSecure(Boolean enrolledIn3DSecure) { @@ -118,6 +127,11 @@ public String getMcc() { } + /** + * The merchant category code (MCC) is a four-digit number which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. The list of MCCs can be found [here](https://en.wikipedia.org/wiki/Merchant_category_code). + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { diff --git a/src/main/java/com/adyen/model/binlookup/Recurring.java b/src/main/java/com/adyen/model/binlookup/Recurring.java index f35fe19b0..6a0950697 100644 --- a/src/main/java/com/adyen/model/binlookup/Recurring.java +++ b/src/main/java/com/adyen/model/binlookup/Recurring.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -153,6 +152,11 @@ public ContractEnum getContract() { } + /** + * The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts). + * + * @param contract + */ @JsonProperty(JSON_PROPERTY_CONTRACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContract(ContractEnum contract) { @@ -178,6 +182,11 @@ public String getRecurringDetailName() { } + /** + * A descriptive name for this detail. + * + * @param recurringDetailName + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailName(String recurringDetailName) { @@ -203,6 +212,11 @@ public OffsetDateTime getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(OffsetDateTime recurringExpiry) { @@ -228,6 +242,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -253,6 +272,11 @@ public TokenServiceEnum getTokenService() { } + /** + * The name of the token service. + * + * @param tokenService + */ @JsonProperty(JSON_PROPERTY_TOKEN_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenService(TokenServiceEnum tokenService) { diff --git a/src/main/java/com/adyen/model/binlookup/ServiceError.java b/src/main/java/com/adyen/model/binlookup/ServiceError.java index 797cab528..15f19e17c 100644 --- a/src/main/java/com/adyen/model/binlookup/ServiceError.java +++ b/src/main/java/com/adyen/model/binlookup/ServiceError.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -91,6 +90,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -116,6 +120,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -141,6 +150,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -166,6 +180,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -191,6 +210,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -216,6 +240,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/binlookup/ThreeDS2CardRangeDetail.java b/src/main/java/com/adyen/model/binlookup/ThreeDS2CardRangeDetail.java index 3725647da..0a5561dec 100644 --- a/src/main/java/com/adyen/model/binlookup/ThreeDS2CardRangeDetail.java +++ b/src/main/java/com/adyen/model/binlookup/ThreeDS2CardRangeDetail.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -90,6 +89,11 @@ public List getAcsInfoInd() { } + /** + * Provides additional information to the 3DS Server. Possible values: - 01 (Authentication is available at ACS) - 02 (Attempts supported by ACS or DS) - 03 (Decoupled authentication supported) - 04 (Whitelisting supported) + * + * @param acsInfoInd + */ @JsonProperty(JSON_PROPERTY_ACS_INFO_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsInfoInd(List acsInfoInd) { @@ -115,6 +119,11 @@ public String getBrandCode() { } + /** + * Card brand. + * + * @param brandCode + */ @JsonProperty(JSON_PROPERTY_BRAND_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrandCode(String brandCode) { @@ -140,6 +149,11 @@ public String getEndRange() { } + /** + * BIN end range. + * + * @param endRange + */ @JsonProperty(JSON_PROPERTY_END_RANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEndRange(String endRange) { @@ -165,6 +179,11 @@ public String getStartRange() { } + /** + * BIN start range. + * + * @param startRange + */ @JsonProperty(JSON_PROPERTY_START_RANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartRange(String startRange) { @@ -198,6 +217,11 @@ public List getThreeDS2Versions() { } + /** + * Supported 3D Secure protocol versions + * + * @param threeDS2Versions + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_VERSIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Versions(List threeDS2Versions) { @@ -223,6 +247,11 @@ public String getThreeDSMethodURL() { } + /** + * In a 3D Secure 2 browser-based flow, this is the URL where you should send the device fingerprint to. + * + * @param threeDSMethodURL + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_METHOD_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSMethodURL(String threeDSMethodURL) { diff --git a/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityRequest.java b/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityRequest.java index a4d90661e..454ecc899 100644 --- a/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityRequest.java +++ b/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityRequest.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -92,6 +91,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -125,6 +129,11 @@ public List getBrands() { } + /** + * List of brands. + * + * @param brands + */ @JsonProperty(JSON_PROPERTY_BRANDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrands(List brands) { @@ -150,6 +159,11 @@ public String getCardNumber() { } + /** + * Card number or BIN. + * + * @param cardNumber + */ @JsonProperty(JSON_PROPERTY_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardNumber(String cardNumber) { @@ -175,6 +189,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -200,6 +219,11 @@ public String getRecurringDetailReference() { } + /** + * A recurring detail reference corresponding to a card. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -225,6 +249,11 @@ public String getShopperReference() { } + /** + * The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityResponse.java b/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityResponse.java index 3299ef37b..1a8f2bf44 100644 --- a/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityResponse.java +++ b/src/main/java/com/adyen/model/binlookup/ThreeDSAvailabilityResponse.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -81,6 +80,11 @@ public BinDetail getBinDetails() { } + /** + * binDetails + * + * @param binDetails + */ @JsonProperty(JSON_PROPERTY_BIN_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBinDetails(BinDetail binDetails) { @@ -114,6 +118,11 @@ public List getDsPublicKeys() { } + /** + * List of Directory Server (DS) public keys. + * + * @param dsPublicKeys + */ @JsonProperty(JSON_PROPERTY_DS_PUBLIC_KEYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsPublicKeys(List dsPublicKeys) { @@ -139,6 +148,11 @@ public Boolean getThreeDS1Supported() { } + /** + * Indicator if 3D Secure 1 is supported. + * + * @param threeDS1Supported + */ @JsonProperty(JSON_PROPERTY_THREE_D_S1_SUPPORTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS1Supported(Boolean threeDS1Supported) { @@ -172,6 +186,11 @@ public List getThreeDS2CardRangeDetails() { } + /** + * List of brand and card range pairs. + * + * @param threeDS2CardRangeDetails + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_CARD_RANGE_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2CardRangeDetails(List threeDS2CardRangeDetails) { @@ -197,6 +216,11 @@ public Boolean getThreeDS2supported() { } + /** + * Indicator if 3D Secure 2 is supported. + * + * @param threeDS2supported + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2SUPPORTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2supported(Boolean threeDS2supported) { diff --git a/src/main/java/com/adyen/model/checkout/AccountInfo.java b/src/main/java/com/adyen/model/checkout/AccountInfo.java index dffc2fa13..1860cc399 100644 --- a/src/main/java/com/adyen/model/checkout/AccountInfo.java +++ b/src/main/java/com/adyen/model/checkout/AccountInfo.java @@ -370,6 +370,11 @@ public AccountAgeIndicatorEnum getAccountAgeIndicator() { } + /** + * Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param accountAgeIndicator + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_AGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountAgeIndicator(AccountAgeIndicatorEnum accountAgeIndicator) { @@ -395,6 +400,11 @@ public OffsetDateTime getAccountChangeDate() { } + /** + * Date when the shopper's account was last changed. + * + * @param accountChangeDate + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_CHANGE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountChangeDate(OffsetDateTime accountChangeDate) { @@ -420,6 +430,11 @@ public AccountChangeIndicatorEnum getAccountChangeIndicator() { } + /** + * Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param accountChangeIndicator + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_CHANGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountChangeIndicator(AccountChangeIndicatorEnum accountChangeIndicator) { @@ -445,6 +460,11 @@ public OffsetDateTime getAccountCreationDate() { } + /** + * Date when the shopper's account was created. + * + * @param accountCreationDate + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountCreationDate(OffsetDateTime accountCreationDate) { @@ -470,6 +490,11 @@ public AccountTypeEnum getAccountType() { } + /** + * Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -495,6 +520,11 @@ public Integer getAddCardAttemptsDay() { } + /** + * Number of attempts the shopper tried to add a card to their account in the last day. + * + * @param addCardAttemptsDay + */ @JsonProperty(JSON_PROPERTY_ADD_CARD_ATTEMPTS_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddCardAttemptsDay(Integer addCardAttemptsDay) { @@ -520,6 +550,11 @@ public OffsetDateTime getDeliveryAddressUsageDate() { } + /** + * Date the selected delivery address was first used. + * + * @param deliveryAddressUsageDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS_USAGE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddressUsageDate(OffsetDateTime deliveryAddressUsageDate) { @@ -545,6 +580,11 @@ public DeliveryAddressUsageIndicatorEnum getDeliveryAddressUsageIndicator() { } + /** + * Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param deliveryAddressUsageIndicator + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS_USAGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddressUsageIndicator(DeliveryAddressUsageIndicatorEnum deliveryAddressUsageIndicator) { @@ -572,6 +612,11 @@ public String getHomePhone() { } + /** + * Shopper's home phone number (including the country code). + * + * @param homePhone + */ @Deprecated @JsonProperty(JSON_PROPERTY_HOME_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -600,6 +645,11 @@ public String getMobilePhone() { } + /** + * Shopper's mobile phone number (including the country code). + * + * @param mobilePhone + */ @Deprecated @JsonProperty(JSON_PROPERTY_MOBILE_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -626,6 +676,11 @@ public OffsetDateTime getPasswordChangeDate() { } + /** + * Date when the shopper last changed their password. + * + * @param passwordChangeDate + */ @JsonProperty(JSON_PROPERTY_PASSWORD_CHANGE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPasswordChangeDate(OffsetDateTime passwordChangeDate) { @@ -651,6 +706,11 @@ public PasswordChangeIndicatorEnum getPasswordChangeIndicator() { } + /** + * Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param passwordChangeIndicator + */ @JsonProperty(JSON_PROPERTY_PASSWORD_CHANGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPasswordChangeIndicator(PasswordChangeIndicatorEnum passwordChangeIndicator) { @@ -676,6 +736,11 @@ public Integer getPastTransactionsDay() { } + /** + * Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. + * + * @param pastTransactionsDay + */ @JsonProperty(JSON_PROPERTY_PAST_TRANSACTIONS_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPastTransactionsDay(Integer pastTransactionsDay) { @@ -701,6 +766,11 @@ public Integer getPastTransactionsYear() { } + /** + * Number of all transactions (successful and abandoned) from this shopper in the past year. + * + * @param pastTransactionsYear + */ @JsonProperty(JSON_PROPERTY_PAST_TRANSACTIONS_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPastTransactionsYear(Integer pastTransactionsYear) { @@ -726,6 +796,11 @@ public OffsetDateTime getPaymentAccountAge() { } + /** + * Date this payment method was added to the shopper's account. + * + * @param paymentAccountAge + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_AGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountAge(OffsetDateTime paymentAccountAge) { @@ -751,6 +826,11 @@ public PaymentAccountIndicatorEnum getPaymentAccountIndicator() { } + /** + * Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param paymentAccountIndicator + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountIndicator(PaymentAccountIndicatorEnum paymentAccountIndicator) { @@ -776,6 +856,11 @@ public Integer getPurchasesLast6Months() { } + /** + * Number of successful purchases in the last six months. + * + * @param purchasesLast6Months + */ @JsonProperty(JSON_PROPERTY_PURCHASES_LAST6_MONTHS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPurchasesLast6Months(Integer purchasesLast6Months) { @@ -801,6 +886,11 @@ public Boolean getSuspiciousActivity() { } + /** + * Whether suspicious activity was recorded on this account. + * + * @param suspiciousActivity + */ @JsonProperty(JSON_PROPERTY_SUSPICIOUS_ACTIVITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSuspiciousActivity(Boolean suspiciousActivity) { @@ -828,6 +918,11 @@ public String getWorkPhone() { } + /** + * Shopper's work phone number (including the country code). + * + * @param workPhone + */ @Deprecated @JsonProperty(JSON_PROPERTY_WORK_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/src/main/java/com/adyen/model/checkout/AcctInfo.java b/src/main/java/com/adyen/model/checkout/AcctInfo.java index 6d7bb9740..38a776fb8 100644 --- a/src/main/java/com/adyen/model/checkout/AcctInfo.java +++ b/src/main/java/com/adyen/model/checkout/AcctInfo.java @@ -390,6 +390,11 @@ public ChAccAgeIndEnum getChAccAgeInd() { } + /** + * Length of time that the cardholder has had the account with the 3DS Requestor. Allowed values: * **01** — No account * **02** — Created during this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days + * + * @param chAccAgeInd + */ @JsonProperty(JSON_PROPERTY_CH_ACC_AGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccAgeInd(ChAccAgeIndEnum chAccAgeInd) { @@ -415,6 +420,11 @@ public String getChAccChange() { } + /** + * Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Format: **YYYYMMDD** + * + * @param chAccChange + */ @JsonProperty(JSON_PROPERTY_CH_ACC_CHANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccChange(String chAccChange) { @@ -440,6 +450,11 @@ public ChAccChangeIndEnum getChAccChangeInd() { } + /** + * Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Allowed values: * **01** — Changed during this transaction * **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60 days + * + * @param chAccChangeInd + */ @JsonProperty(JSON_PROPERTY_CH_ACC_CHANGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccChangeInd(ChAccChangeIndEnum chAccChangeInd) { @@ -465,6 +480,11 @@ public String getChAccPwChange() { } + /** + * Date that cardholder’s account with the 3DS Requestor had a password change or account reset. Format: **YYYYMMDD** + * + * @param chAccPwChange + */ @JsonProperty(JSON_PROPERTY_CH_ACC_PW_CHANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccPwChange(String chAccPwChange) { @@ -490,6 +510,11 @@ public ChAccPwChangeIndEnum getChAccPwChangeInd() { } + /** + * Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. Allowed values: * **01** — No change * **02** — Changed during this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days + * + * @param chAccPwChangeInd + */ @JsonProperty(JSON_PROPERTY_CH_ACC_PW_CHANGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccPwChangeInd(ChAccPwChangeIndEnum chAccPwChangeInd) { @@ -515,6 +540,11 @@ public String getChAccString() { } + /** + * Date that the cardholder opened the account with the 3DS Requestor. Format: **YYYYMMDD** + * + * @param chAccString + */ @JsonProperty(JSON_PROPERTY_CH_ACC_STRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccString(String chAccString) { @@ -540,6 +570,11 @@ public String getNbPurchaseAccount() { } + /** + * Number of purchases with this cardholder account during the previous six months. Max length: 4 characters. + * + * @param nbPurchaseAccount + */ @JsonProperty(JSON_PROPERTY_NB_PURCHASE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNbPurchaseAccount(String nbPurchaseAccount) { @@ -565,6 +600,11 @@ public String getPaymentAccAge() { } + /** + * String that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Format: **YYYYMMDD** + * + * @param paymentAccAge + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACC_AGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccAge(String paymentAccAge) { @@ -590,6 +630,11 @@ public PaymentAccIndEnum getPaymentAccInd() { } + /** + * Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Allowed values: * **01** — No account (guest checkout) * **02** — During this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days + * + * @param paymentAccInd + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACC_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccInd(PaymentAccIndEnum paymentAccInd) { @@ -615,6 +660,11 @@ public String getProvisionAttemptsDay() { } + /** + * Number of Add Card attempts in the last 24 hours. Max length: 3 characters. + * + * @param provisionAttemptsDay + */ @JsonProperty(JSON_PROPERTY_PROVISION_ATTEMPTS_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProvisionAttemptsDay(String provisionAttemptsDay) { @@ -640,6 +690,11 @@ public String getShipAddressUsage() { } + /** + * String when the shipping address used for this transaction was first used with the 3DS Requestor. Format: **YYYYMMDD** + * + * @param shipAddressUsage + */ @JsonProperty(JSON_PROPERTY_SHIP_ADDRESS_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipAddressUsage(String shipAddressUsage) { @@ -665,6 +720,11 @@ public ShipAddressUsageIndEnum getShipAddressUsageInd() { } + /** + * Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Allowed values: * **01** — This transaction * **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60 days + * + * @param shipAddressUsageInd + */ @JsonProperty(JSON_PROPERTY_SHIP_ADDRESS_USAGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipAddressUsageInd(ShipAddressUsageIndEnum shipAddressUsageInd) { @@ -690,6 +750,11 @@ public ShipNameIndicatorEnum getShipNameIndicator() { } + /** + * Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Allowed values: * **01** — Account Name identical to shipping Name * **02** — Account Name different to shipping Name + * + * @param shipNameIndicator + */ @JsonProperty(JSON_PROPERTY_SHIP_NAME_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipNameIndicator(ShipNameIndicatorEnum shipNameIndicator) { @@ -715,6 +780,11 @@ public SuspiciousAccActivityEnum getSuspiciousAccActivity() { } + /** + * Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Allowed values: * **01** — No suspicious activity has been observed * **02** — Suspicious activity has been observed + * + * @param suspiciousAccActivity + */ @JsonProperty(JSON_PROPERTY_SUSPICIOUS_ACC_ACTIVITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSuspiciousAccActivity(SuspiciousAccActivityEnum suspiciousAccActivity) { @@ -740,6 +810,11 @@ public String getTxnActivityDay() { } + /** + * Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters. + * + * @param txnActivityDay + */ @JsonProperty(JSON_PROPERTY_TXN_ACTIVITY_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxnActivityDay(String txnActivityDay) { @@ -765,6 +840,11 @@ public String getTxnActivityYear() { } + /** + * Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters. + * + * @param txnActivityYear + */ @JsonProperty(JSON_PROPERTY_TXN_ACTIVITY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxnActivityYear(String txnActivityYear) { diff --git a/src/main/java/com/adyen/model/checkout/AchDetails.java b/src/main/java/com/adyen/model/checkout/AchDetails.java index 768e6e18a..78cde4a51 100644 --- a/src/main/java/com/adyen/model/checkout/AchDetails.java +++ b/src/main/java/com/adyen/model/checkout/AchDetails.java @@ -175,6 +175,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -200,6 +205,11 @@ public BankAccountTypeEnum getBankAccountType() { } + /** + * The bank account type (checking, savings...). + * + * @param bankAccountType + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountType(BankAccountTypeEnum bankAccountType) { @@ -225,6 +235,11 @@ public String getBankLocationId() { } + /** + * The bank routing number of the account. The field value is `nil` in most cases. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -250,6 +265,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -275,6 +295,11 @@ public String getEncryptedBankAccountNumber() { } + /** + * Encrypted bank account number. The bank account number (without separators). + * + * @param encryptedBankAccountNumber + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedBankAccountNumber(String encryptedBankAccountNumber) { @@ -300,6 +325,11 @@ public String getEncryptedBankLocationId() { } + /** + * Encrypted location id. The bank routing number of the account. The field value is `nil` in most cases. + * + * @param encryptedBankLocationId + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedBankLocationId(String encryptedBankLocationId) { @@ -325,6 +355,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -352,6 +387,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -378,6 +418,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -403,6 +448,11 @@ public TypeEnum getType() { } + /** + * **ach** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalData3DSecure.java b/src/main/java/com/adyen/model/checkout/AdditionalData3DSecure.java index dac62e445..55014bd0f 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalData3DSecure.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalData3DSecure.java @@ -122,6 +122,11 @@ public String getAllow3DS2() { } + /** + * Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. + * + * @param allow3DS2 + */ @Deprecated @JsonProperty(JSON_PROPERTY_ALLOW3_D_S2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -148,6 +153,11 @@ public ChallengeWindowSizeEnum getChallengeWindowSize() { } + /** + * Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen + * + * @param challengeWindowSize + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_WINDOW_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeWindowSize(ChallengeWindowSizeEnum challengeWindowSize) { @@ -175,6 +185,11 @@ public String getExecuteThreeD() { } + /** + * Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. + * + * @param executeThreeD + */ @Deprecated @JsonProperty(JSON_PROPERTY_EXECUTE_THREE_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -201,6 +216,11 @@ public String getMpiImplementationType() { } + /** + * In case of Secure+, this field must be set to **CUPSecurePlus**. + * + * @param mpiImplementationType + */ @JsonProperty(JSON_PROPERTY_MPI_IMPLEMENTATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiImplementationType(String mpiImplementationType) { @@ -226,6 +246,11 @@ public String getScaExemption() { } + /** + * Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + * + * @param scaExemption + */ @JsonProperty(JSON_PROPERTY_SCA_EXEMPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScaExemption(String scaExemption) { @@ -251,6 +276,11 @@ public String getThreeDSVersion() { } + /** + * Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataAirline.java b/src/main/java/com/adyen/model/checkout/AdditionalDataAirline.java index 465f35565..6b7376c18 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataAirline.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataAirline.java @@ -167,6 +167,11 @@ public String getAirlineAgencyInvoiceNumber() { } + /** + * The reference number for the invoice, issued by the agency. * Encoding: ASCII * minLength: 1 character * maxLength: 6 characters + * + * @param airlineAgencyInvoiceNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AGENCY_INVOICE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAgencyInvoiceNumber(String airlineAgencyInvoiceNumber) { @@ -192,6 +197,11 @@ public String getAirlineAgencyPlanName() { } + /** + * The two-letter agency plan identifier. * Encoding: ASCII * minLength: 2 characters * maxLength: 2 characters + * + * @param airlineAgencyPlanName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AGENCY_PLAN_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAgencyPlanName(String airlineAgencyPlanName) { @@ -217,6 +227,11 @@ public String getAirlineAirlineCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier. * Format: IATA 3-digit accounting code (PAX) * Example: KLM = 074 * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineAirlineCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AIRLINE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAirlineCode(String airlineAirlineCode) { @@ -242,6 +257,11 @@ public String getAirlineAirlineDesignatorCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. * Encoding: ASCII * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineAirlineDesignatorCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AIRLINE_DESIGNATOR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAirlineDesignatorCode(String airlineAirlineDesignatorCode) { @@ -267,6 +287,11 @@ public String getAirlineBoardingFee() { } + /** + * The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 character * maxLength: 18 characters + * + * @param airlineBoardingFee + */ @JsonProperty(JSON_PROPERTY_AIRLINE_BOARDING_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineBoardingFee(String airlineBoardingFee) { @@ -292,6 +317,11 @@ public String getAirlineComputerizedReservationSystem() { } + /** + * The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Encoding: ASCII * minLength: 4 characters * maxLength: 4 characters + * + * @param airlineComputerizedReservationSystem + */ @JsonProperty(JSON_PROPERTY_AIRLINE_COMPUTERIZED_RESERVATION_SYSTEM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineComputerizedReservationSystem(String airlineComputerizedReservationSystem) { @@ -317,6 +347,11 @@ public String getAirlineCustomerReferenceNumber() { } + /** + * The alphanumeric customer reference number. * Encoding: ASCII * maxLength: 20 characters * If you send more than 20 characters, the customer reference number is truncated * Must not be all spaces + * + * @param airlineCustomerReferenceNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_CUSTOMER_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineCustomerReferenceNumber(String airlineCustomerReferenceNumber) { @@ -342,6 +377,11 @@ public String getAirlineDocumentType() { } + /** + * A code that identifies the type of item bought. The description of the code can appear on credit card statements. * Encoding: ASCII * Example: Passenger ticket = 01 * minLength: 2 characters * maxLength: 2 characters + * + * @param airlineDocumentType + */ @JsonProperty(JSON_PROPERTY_AIRLINE_DOCUMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineDocumentType(String airlineDocumentType) { @@ -367,6 +407,11 @@ public String getAirlineFlightDate() { } + /** + * The flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 characters * maxLength: 16 characters + * + * @param airlineFlightDate + */ @JsonProperty(JSON_PROPERTY_AIRLINE_FLIGHT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineFlightDate(String airlineFlightDate) { @@ -392,6 +437,11 @@ public String getAirlineLegCarrierCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. This field is required if the airline data includes leg details. * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegCarrierCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_CARRIER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegCarrierCode(String airlineLegCarrierCode) { @@ -417,6 +467,11 @@ public String getAirlineLegClassOfTravel() { } + /** + * A one-letter travel class identifier. The following are common: * F: first class * J: business class * Y: economy class * W: premium economy * Encoding: ASCII * minLength: 1 character * maxLength: 1 character * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegClassOfTravel + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_CLASS_OF_TRAVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegClassOfTravel(String airlineLegClassOfTravel) { @@ -442,6 +497,11 @@ public String getAirlineLegDateOfTravel() { } + /** + * Date and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`. * Encoding: ASCII * minLength: 16 characters * maxLength: 16 characters + * + * @param airlineLegDateOfTravel + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DATE_OF_TRAVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDateOfTravel(String airlineLegDateOfTravel) { @@ -467,6 +527,11 @@ public String getAirlineLegDepartAirport() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport. This field is required if the airline data includes leg details. * Encoding: ASCII * Example: Amsterdam = AMS * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegDepartAirport + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DEPART_AIRPORT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDepartAirport(String airlineLegDepartAirport) { @@ -492,6 +557,11 @@ public String getAirlineLegDepartTax() { } + /** + * The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 * maxLength: 12 *Must not be all zeros. + * + * @param airlineLegDepartTax + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DEPART_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDepartTax(String airlineLegDepartTax) { @@ -517,6 +587,11 @@ public String getAirlineLegDestinationCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport. This field is required if the airline data includes leg details. * Example: Amsterdam = AMS * Encoding: ASCII * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegDestinationCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DESTINATION_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDestinationCode(String airlineLegDestinationCode) { @@ -542,6 +617,11 @@ public String getAirlineLegFareBaseCode() { } + /** + * The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric. * minLength: 1 character * maxLength: 6 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegFareBaseCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_FARE_BASE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegFareBaseCode(String airlineLegFareBaseCode) { @@ -567,6 +647,11 @@ public String getAirlineLegFlightNumber() { } + /** + * The flight identifier. * minLength: 1 character * maxLength: 5 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegFlightNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_FLIGHT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegFlightNumber(String airlineLegFlightNumber) { @@ -592,6 +677,11 @@ public String getAirlineLegStopOverCode() { } + /** + * A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not. * Encoding: ASCII * minLength: 1 character * maxLength: 1 character + * + * @param airlineLegStopOverCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_STOP_OVER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegStopOverCode(String airlineLegStopOverCode) { @@ -617,6 +707,11 @@ public String getAirlinePassengerDateOfBirth() { } + /** + * The passenger's date of birth. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10 + * + * @param airlinePassengerDateOfBirth + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerDateOfBirth(String airlinePassengerDateOfBirth) { @@ -642,6 +737,11 @@ public String getAirlinePassengerFirstName() { } + /** + * The passenger's first name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII + * + * @param airlinePassengerFirstName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerFirstName(String airlinePassengerFirstName) { @@ -667,6 +767,11 @@ public String getAirlinePassengerLastName() { } + /** + * The passenger's last name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII + * + * @param airlinePassengerLastName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerLastName(String airlinePassengerLastName) { @@ -692,6 +797,11 @@ public String getAirlinePassengerTelephoneNumber() { } + /** + * The passenger's telephone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs. * Encoding: ASCII * minLength: 3 characters * maxLength: 30 characters + * + * @param airlinePassengerTelephoneNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerTelephoneNumber(String airlinePassengerTelephoneNumber) { @@ -717,6 +827,11 @@ public String getAirlinePassengerTravellerType() { } + /** + * The IATA passenger type code (PTC). * Encoding: ASCII * minLength: 3 characters * maxLength: 6 characters + * + * @param airlinePassengerTravellerType + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_TRAVELLER_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerTravellerType(String airlinePassengerTravellerType) { @@ -742,6 +857,11 @@ public String getAirlinePassengerName() { } + /** + * The passenger's name, initials, and title. * Format: last name + first name or initials + title * Example: *FLYER / MARY MS* * minLength: 1 character * maxLength: 20 characters * If you send more than 20 characters, the name is truncated * Must not be all spaces *Must not be all zeros. + * + * @param airlinePassengerName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerName(String airlinePassengerName) { @@ -767,6 +887,11 @@ public String getAirlineTicketIssueAddress() { } + /** + * The address of the organization that issued the ticket. * minLength: 0 characters * maxLength: 16 characters + * + * @param airlineTicketIssueAddress + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TICKET_ISSUE_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTicketIssueAddress(String airlineTicketIssueAddress) { @@ -792,6 +917,11 @@ public String getAirlineTicketNumber() { } + /** + * The ticket's unique identifier. * minLength: 1 character * maxLength: 15 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineTicketNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TICKET_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTicketNumber(String airlineTicketNumber) { @@ -817,6 +947,11 @@ public String getAirlineTravelAgencyCode() { } + /** + * The unique identifier from IATA or ARC for the travel agency that issues the ticket. * Encoding: ASCII * minLength: 1 character * maxLength: 8 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineTravelAgencyCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TRAVEL_AGENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTravelAgencyCode(String airlineTravelAgencyCode) { @@ -842,6 +977,11 @@ public String getAirlineTravelAgencyName() { } + /** + * The name of the travel agency. * Encoding: ASCII * minLength: 1 character * maxLength: 25 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineTravelAgencyName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TRAVEL_AGENCY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTravelAgencyName(String airlineTravelAgencyName) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataCarRental.java b/src/main/java/com/adyen/model/checkout/AdditionalDataCarRental.java index 5462fb12d..cecbde0b7 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataCarRental.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataCarRental.java @@ -147,6 +147,11 @@ public String getCarRentalCheckOutDate() { } + /** + * The pick-up date. * Date format: `yyyyMMdd` + * + * @param carRentalCheckOutDate + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_CHECK_OUT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalCheckOutDate(String carRentalCheckOutDate) { @@ -172,6 +177,11 @@ public String getCarRentalCustomerServiceTollFreeNumber() { } + /** + * The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros. + * + * @param carRentalCustomerServiceTollFreeNumber + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_CUSTOMER_SERVICE_TOLL_FREE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalCustomerServiceTollFreeNumber(String carRentalCustomerServiceTollFreeNumber) { @@ -197,6 +207,11 @@ public String getCarRentalDaysRented() { } + /** + * Number of days for which the car is being rented. * Format: Numeric * maxLength: 4 * Must not be all spaces + * + * @param carRentalDaysRented + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_DAYS_RENTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalDaysRented(String carRentalDaysRented) { @@ -222,6 +237,11 @@ public String getCarRentalFuelCharges() { } + /** + * Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12 + * + * @param carRentalFuelCharges + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_FUEL_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalFuelCharges(String carRentalFuelCharges) { @@ -247,6 +267,11 @@ public String getCarRentalInsuranceCharges() { } + /** + * Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12 * Must not be all spaces *Must not be all zeros. + * + * @param carRentalInsuranceCharges + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_INSURANCE_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalInsuranceCharges(String carRentalInsuranceCharges) { @@ -272,6 +297,11 @@ public String getCarRentalLocationCity() { } + /** + * The city where the car is rented. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalLocationCity + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_LOCATION_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalLocationCity(String carRentalLocationCity) { @@ -297,6 +327,11 @@ public String getCarRentalLocationCountry() { } + /** + * The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2 + * + * @param carRentalLocationCountry + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_LOCATION_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalLocationCountry(String carRentalLocationCountry) { @@ -322,6 +357,11 @@ public String getCarRentalLocationStateProvince() { } + /** + * The state or province where the car is rented. * Format: Alphanumeric * maxLength: 2 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalLocationStateProvince + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_LOCATION_STATE_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalLocationStateProvince(String carRentalLocationStateProvince) { @@ -347,6 +387,11 @@ public String getCarRentalNoShowIndicator() { } + /** + * Indicates if the customer didn't pick up their rental car. * Y - Customer did not pick up their car * N - Not applicable + * + * @param carRentalNoShowIndicator + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_NO_SHOW_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalNoShowIndicator(String carRentalNoShowIndicator) { @@ -372,6 +417,11 @@ public String getCarRentalOneWayDropOffCharges() { } + /** + * The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 12 + * + * @param carRentalOneWayDropOffCharges + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_ONE_WAY_DROP_OFF_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalOneWayDropOffCharges(String carRentalOneWayDropOffCharges) { @@ -397,6 +447,11 @@ public String getCarRentalRate() { } + /** + * The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Alphanumeric * maxLength: 12 + * + * @param carRentalRate + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRate(String carRentalRate) { @@ -422,6 +477,11 @@ public String getCarRentalRateIndicator() { } + /** + * Specifies whether the given rate is applied daily or weekly. * D - Daily rate * W - Weekly rate + * + * @param carRentalRateIndicator + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RATE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRateIndicator(String carRentalRateIndicator) { @@ -447,6 +507,11 @@ public String getCarRentalRentalAgreementNumber() { } + /** + * The rental agreement number for the car rental. * Format: Alphanumeric * maxLength: 9 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalRentalAgreementNumber + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RENTAL_AGREEMENT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRentalAgreementNumber(String carRentalRentalAgreementNumber) { @@ -472,6 +537,11 @@ public String getCarRentalRentalClassId() { } + /** + * The classification of the rental car. * Format: Alphanumeric * maxLength: 4 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalRentalClassId + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RENTAL_CLASS_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRentalClassId(String carRentalRentalClassId) { @@ -497,6 +567,11 @@ public String getCarRentalRenterName() { } + /** + * The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 * If you send more than 26 characters, the name is truncated * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalRenterName + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RENTER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRenterName(String carRentalRenterName) { @@ -522,6 +597,11 @@ public String getCarRentalReturnCity() { } + /** + * The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalReturnCity + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnCity(String carRentalReturnCity) { @@ -547,6 +627,11 @@ public String getCarRentalReturnCountry() { } + /** + * The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2 + * + * @param carRentalReturnCountry + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnCountry(String carRentalReturnCountry) { @@ -572,6 +657,11 @@ public String getCarRentalReturnDate() { } + /** + * The last date to return the car by. * Date format: `yyyyMMdd` * maxLength: 8 + * + * @param carRentalReturnDate + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnDate(String carRentalReturnDate) { @@ -597,6 +687,11 @@ public String getCarRentalReturnLocationId() { } + /** + * The agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalReturnLocationId + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnLocationId(String carRentalReturnLocationId) { @@ -622,6 +717,11 @@ public String getCarRentalReturnStateProvince() { } + /** + * The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalReturnStateProvince + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_STATE_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnStateProvince(String carRentalReturnStateProvince) { @@ -647,6 +747,11 @@ public String getCarRentalTaxExemptIndicator() { } + /** + * Indicates if the goods or services were tax-exempt, or if tax was not paid on them. Values: * Y - Goods or services were tax exempt * N - Tax was not collected + * + * @param carRentalTaxExemptIndicator + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_TAX_EXEMPT_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalTaxExemptIndicator(String carRentalTaxExemptIndicator) { @@ -672,6 +777,11 @@ public String getTravelEntertainmentAuthDataDuration() { } + /** + * Number of days the car is rented for. This should be included in the auth message. * Format: Numeric * maxLength: 4 + * + * @param travelEntertainmentAuthDataDuration + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_DURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataDuration(String travelEntertainmentAuthDataDuration) { @@ -697,6 +807,11 @@ public String getTravelEntertainmentAuthDataMarket() { } + /** + * Indicates what market-specific dataset will be submitted or is being submitted. Value should be 'A' for car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 + * + * @param travelEntertainmentAuthDataMarket + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_MARKET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataMarket(String travelEntertainmentAuthDataMarket) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataCommon.java b/src/main/java/com/adyen/model/checkout/AdditionalDataCommon.java index 8c974ad47..257eb0616 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataCommon.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataCommon.java @@ -154,6 +154,11 @@ public String getRequestedTestErrorResponseCode() { } + /** + * Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. + * + * @param requestedTestErrorResponseCode + */ @JsonProperty(JSON_PROPERTY_REQUESTED_TEST_ERROR_RESPONSE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedTestErrorResponseCode(String requestedTestErrorResponseCode) { @@ -179,6 +184,11 @@ public String getAllowPartialAuth() { } + /** + * Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team. + * + * @param allowPartialAuth + */ @JsonProperty(JSON_PROPERTY_ALLOW_PARTIAL_AUTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowPartialAuth(String allowPartialAuth) { @@ -204,6 +214,11 @@ public String getAuthorisationType() { } + /** + * Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation. + * + * @param authorisationType + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationType(String authorisationType) { @@ -229,6 +244,11 @@ public String getCustomRoutingFlag() { } + /** + * Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param customRoutingFlag + */ @JsonProperty(JSON_PROPERTY_CUSTOM_ROUTING_FLAG) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomRoutingFlag(String customRoutingFlag) { @@ -254,6 +274,11 @@ public IndustryUsageEnum getIndustryUsage() { } + /** + * In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed. + * + * @param industryUsage + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryUsage(IndustryUsageEnum industryUsage) { @@ -279,6 +304,11 @@ public String getManualCapture() { } + /** + * Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction. + * + * @param manualCapture + */ @JsonProperty(JSON_PROPERTY_MANUAL_CAPTURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setManualCapture(String manualCapture) { @@ -304,6 +334,11 @@ public String getNetworkTxReference() { } + /** + * Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -329,6 +364,11 @@ public String getOverwriteBrand() { } + /** + * Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction. + * + * @param overwriteBrand + */ @JsonProperty(JSON_PROPERTY_OVERWRITE_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverwriteBrand(String overwriteBrand) { @@ -354,6 +394,11 @@ public String getSubMerchantCity() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters. + * + * @param subMerchantCity + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantCity(String subMerchantCity) { @@ -379,6 +424,11 @@ public String getSubMerchantCountry() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters. + * + * @param subMerchantCountry + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantCountry(String subMerchantCountry) { @@ -404,6 +454,11 @@ public String getSubMerchantID() { } + /** + * This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters. + * + * @param subMerchantID + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantID(String subMerchantID) { @@ -429,6 +484,11 @@ public String getSubMerchantName() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters. + * + * @param subMerchantName + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantName(String subMerchantName) { @@ -454,6 +514,11 @@ public String getSubMerchantPostalCode() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters. + * + * @param subMerchantPostalCode + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantPostalCode(String subMerchantPostalCode) { @@ -479,6 +544,11 @@ public String getSubMerchantState() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters. + * + * @param subMerchantState + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantState(String subMerchantState) { @@ -504,6 +574,11 @@ public String getSubMerchantStreet() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters. + * + * @param subMerchantStreet + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantStreet(String subMerchantStreet) { @@ -529,6 +604,11 @@ public String getSubMerchantTaxId() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters. + * + * @param subMerchantTaxId + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantTaxId(String subMerchantTaxId) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataLevel23.java b/src/main/java/com/adyen/model/checkout/AdditionalDataLevel23.java index 525a2d51d..1629505a1 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataLevel23.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataLevel23.java @@ -123,6 +123,11 @@ public String getEnhancedSchemeDataCustomerReference() { } + /** + * The customer code. * Encoding: ASCII * Max length: 25 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataCustomerReference + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_CUSTOMER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataCustomerReference(String enhancedSchemeDataCustomerReference) { @@ -148,6 +153,11 @@ public String getEnhancedSchemeDataDestinationCountryCode() { } + /** + * The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. * Encoding: ASCII * Fixed length: 3 characters + * + * @param enhancedSchemeDataDestinationCountryCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DESTINATION_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDestinationCountryCode(String enhancedSchemeDataDestinationCountryCode) { @@ -173,6 +183,11 @@ public String getEnhancedSchemeDataDestinationPostalCode() { } + /** + * The postal code of the destination address. * Encoding: ASCII * Max length: 10 characters * Must not start with a space + * + * @param enhancedSchemeDataDestinationPostalCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DESTINATION_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDestinationPostalCode(String enhancedSchemeDataDestinationPostalCode) { @@ -198,6 +213,11 @@ public String getEnhancedSchemeDataDestinationStateProvinceCode() { } + /** + * Destination state or province code. * Encoding: ASCII * Max length: 3 characters * Must not start with a space + * + * @param enhancedSchemeDataDestinationStateProvinceCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DESTINATION_STATE_PROVINCE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDestinationStateProvinceCode(String enhancedSchemeDataDestinationStateProvinceCode) { @@ -223,6 +243,11 @@ public String getEnhancedSchemeDataDutyAmount() { } + /** + * The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters + * + * @param enhancedSchemeDataDutyAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DUTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDutyAmount(String enhancedSchemeDataDutyAmount) { @@ -248,6 +273,11 @@ public String getEnhancedSchemeDataFreightAmount() { } + /** + * The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric *Max length: 12 characters + * + * @param enhancedSchemeDataFreightAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_FREIGHT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataFreightAmount(String enhancedSchemeDataFreightAmount) { @@ -273,6 +303,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrCommodityCode() { } + /** + * The [UNSPC commodity code](https://www.unspsc.org/) of the item. * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrCommodityCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_COMMODITY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrCommodityCode(String enhancedSchemeDataItemDetailLineItemNrCommodityCode) { @@ -298,6 +333,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrDescription() { } + /** + * A description of the item. * Encoding: ASCII * Max length: 26 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrDescription + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrDescription(String enhancedSchemeDataItemDetailLineItemNrDescription) { @@ -323,6 +363,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrDiscountAmount() { } + /** + * The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters + * + * @param enhancedSchemeDataItemDetailLineItemNrDiscountAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_DISCOUNT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrDiscountAmount(String enhancedSchemeDataItemDetailLineItemNrDiscountAmount) { @@ -348,6 +393,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrProductCode() { } + /** + * The product code. * Encoding: ASCII. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrProductCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_PRODUCT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrProductCode(String enhancedSchemeDataItemDetailLineItemNrProductCode) { @@ -373,6 +423,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrQuantity() { } + /** + * The number of items. Must be an integer greater than zero. * Encoding: Numeric * Max length: 12 characters * Must not start with a space or be all spaces + * + * @param enhancedSchemeDataItemDetailLineItemNrQuantity + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_QUANTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrQuantity(String enhancedSchemeDataItemDetailLineItemNrQuantity) { @@ -398,6 +453,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrTotalAmount() { } + /** + * The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrTotalAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_TOTAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrTotalAmount(String enhancedSchemeDataItemDetailLineItemNrTotalAmount) { @@ -423,6 +483,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrUnitOfMeasure() { } + /** + * The unit of measurement for an item. * Encoding: ASCII Max length: 3 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrUnitOfMeasure + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_UNIT_OF_MEASURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrUnitOfMeasure(String enhancedSchemeDataItemDetailLineItemNrUnitOfMeasure) { @@ -448,6 +513,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrUnitPrice() { } + /** + * The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrUnitPrice + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_UNIT_PRICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrUnitPrice(String enhancedSchemeDataItemDetailLineItemNrUnitPrice) { @@ -473,6 +543,11 @@ public String getEnhancedSchemeDataOrderDate() { } + /** + * The order date. * Format: `ddMMyy` * Encoding: ASCII * Max length: 6 characters + * + * @param enhancedSchemeDataOrderDate + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ORDER_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataOrderDate(String enhancedSchemeDataOrderDate) { @@ -498,6 +573,11 @@ public String getEnhancedSchemeDataShipFromPostalCode() { } + /** + * The postal code of the address the item is shipped from. * Encoding: ASCII * Max length: 10 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataShipFromPostalCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_SHIP_FROM_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataShipFromPostalCode(String enhancedSchemeDataShipFromPostalCode) { @@ -523,6 +603,11 @@ public String getEnhancedSchemeDataTotalTaxAmount() { } + /** + * The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. *Encoding: Numeric *Max length: 12 characters * Must not be all zeros. + * + * @param enhancedSchemeDataTotalTaxAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TOTAL_TAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTotalTaxAmount(String enhancedSchemeDataTotalTaxAmount) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataLodging.java b/src/main/java/com/adyen/model/checkout/AdditionalDataLodging.java index e81ea6506..724091c85 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataLodging.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataLodging.java @@ -119,6 +119,11 @@ public String getLodgingCheckInDate() { } + /** + * The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**. + * + * @param lodgingCheckInDate + */ @JsonProperty(JSON_PROPERTY_LODGING_CHECK_IN_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingCheckInDate(String lodgingCheckInDate) { @@ -144,6 +149,11 @@ public String getLodgingCheckOutDate() { } + /** + * The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**. + * + * @param lodgingCheckOutDate + */ @JsonProperty(JSON_PROPERTY_LODGING_CHECK_OUT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingCheckOutDate(String lodgingCheckOutDate) { @@ -169,6 +179,11 @@ public String getLodgingCustomerServiceTollFreeNumber() { } + /** + * The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros. + * + * @param lodgingCustomerServiceTollFreeNumber + */ @JsonProperty(JSON_PROPERTY_LODGING_CUSTOMER_SERVICE_TOLL_FREE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingCustomerServiceTollFreeNumber(String lodgingCustomerServiceTollFreeNumber) { @@ -194,6 +209,11 @@ public String getLodgingFireSafetyActIndicator() { } + /** + * Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'. * Format: alphabetic * Max length: 1 character + * + * @param lodgingFireSafetyActIndicator + */ @JsonProperty(JSON_PROPERTY_LODGING_FIRE_SAFETY_ACT_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFireSafetyActIndicator(String lodgingFireSafetyActIndicator) { @@ -219,6 +239,11 @@ public String getLodgingFolioCashAdvances() { } + /** + * The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters + * + * @param lodgingFolioCashAdvances + */ @JsonProperty(JSON_PROPERTY_LODGING_FOLIO_CASH_ADVANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFolioCashAdvances(String lodgingFolioCashAdvances) { @@ -244,6 +269,11 @@ public String getLodgingFolioNumber() { } + /** + * The card acceptor’s internal invoice or billing ID reference number. * Max length: 25 characters. * Must not start with a space *Must not be all zeros. + * + * @param lodgingFolioNumber + */ @JsonProperty(JSON_PROPERTY_LODGING_FOLIO_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFolioNumber(String lodgingFolioNumber) { @@ -269,6 +299,11 @@ public String getLodgingFoodBeverageCharges() { } + /** + * Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters + * + * @param lodgingFoodBeverageCharges + */ @JsonProperty(JSON_PROPERTY_LODGING_FOOD_BEVERAGE_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFoodBeverageCharges(String lodgingFoodBeverageCharges) { @@ -294,6 +329,11 @@ public String getLodgingNoShowIndicator() { } + /** + * Indicates if the customer didn't check in for their booking. Possible values: * **Y**: the customer didn't check in * **N**: the customer checked in + * + * @param lodgingNoShowIndicator + */ @JsonProperty(JSON_PROPERTY_LODGING_NO_SHOW_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingNoShowIndicator(String lodgingNoShowIndicator) { @@ -319,6 +359,11 @@ public String getLodgingPrepaidExpenses() { } + /** + * The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters + * + * @param lodgingPrepaidExpenses + */ @JsonProperty(JSON_PROPERTY_LODGING_PREPAID_EXPENSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingPrepaidExpenses(String lodgingPrepaidExpenses) { @@ -344,6 +389,11 @@ public String getLodgingPropertyPhoneNumber() { } + /** + * The lodging property location's phone number. * Format: numeric. * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros. + * + * @param lodgingPropertyPhoneNumber + */ @JsonProperty(JSON_PROPERTY_LODGING_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingPropertyPhoneNumber(String lodgingPropertyPhoneNumber) { @@ -369,6 +419,11 @@ public String getLodgingRoom1NumberOfNights() { } + /** + * The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters + * + * @param lodgingRoom1NumberOfNights + */ @JsonProperty(JSON_PROPERTY_LODGING_ROOM1_NUMBER_OF_NIGHTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingRoom1NumberOfNights(String lodgingRoom1NumberOfNights) { @@ -394,6 +449,11 @@ public String getLodgingRoom1Rate() { } + /** + * The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number + * + * @param lodgingRoom1Rate + */ @JsonProperty(JSON_PROPERTY_LODGING_ROOM1_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingRoom1Rate(String lodgingRoom1Rate) { @@ -419,6 +479,11 @@ public String getLodgingTotalRoomTax() { } + /** + * The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number + * + * @param lodgingTotalRoomTax + */ @JsonProperty(JSON_PROPERTY_LODGING_TOTAL_ROOM_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingTotalRoomTax(String lodgingTotalRoomTax) { @@ -444,6 +509,11 @@ public String getLodgingTotalTax() { } + /** + * The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number + * + * @param lodgingTotalTax + */ @JsonProperty(JSON_PROPERTY_LODGING_TOTAL_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingTotalTax(String lodgingTotalTax) { @@ -469,6 +539,11 @@ public String getTravelEntertainmentAuthDataDuration() { } + /** + * The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters + * + * @param travelEntertainmentAuthDataDuration + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_DURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataDuration(String travelEntertainmentAuthDataDuration) { @@ -494,6 +569,11 @@ public String getTravelEntertainmentAuthDataMarket() { } + /** + * Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character + * + * @param travelEntertainmentAuthDataMarket + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_MARKET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataMarket(String travelEntertainmentAuthDataMarket) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataOpenInvoice.java b/src/main/java/com/adyen/model/checkout/AdditionalDataOpenInvoice.java index 4b4aa20b9..c035c708e 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataOpenInvoice.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataOpenInvoice.java @@ -127,6 +127,11 @@ public String getOpeninvoicedataMerchantData() { } + /** + * Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. The `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end. Since the field is optional, if it's not included it does not impact computing the merchant signature. Applies only to Klarna. You can contact Klarna for the format and structure of the string. + * + * @param openinvoicedataMerchantData + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_MERCHANT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataMerchantData(String openinvoicedataMerchantData) { @@ -152,6 +157,11 @@ public String getOpeninvoicedataNumberOfLines() { } + /** + * The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1. + * + * @param openinvoicedataNumberOfLines + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_NUMBER_OF_LINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataNumberOfLines(String openinvoicedataNumberOfLines) { @@ -177,6 +187,11 @@ public String getOpeninvoicedataRecipientFirstName() { } + /** + * First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. + * + * @param openinvoicedataRecipientFirstName + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_RECIPIENT_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataRecipientFirstName(String openinvoicedataRecipientFirstName) { @@ -202,6 +217,11 @@ public String getOpeninvoicedataRecipientLastName() { } + /** + * Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. + * + * @param openinvoicedataRecipientLastName + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_RECIPIENT_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataRecipientLastName(String openinvoicedataRecipientLastName) { @@ -227,6 +247,11 @@ public String getOpeninvoicedataLineItemNrCurrencyCode() { } + /** + * The three-character ISO currency code. + * + * @param openinvoicedataLineItemNrCurrencyCode + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrCurrencyCode(String openinvoicedataLineItemNrCurrencyCode) { @@ -252,6 +277,11 @@ public String getOpeninvoicedataLineItemNrDescription() { } + /** + * A text description of the product the invoice line refers to. + * + * @param openinvoicedataLineItemNrDescription + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrDescription(String openinvoicedataLineItemNrDescription) { @@ -277,6 +307,11 @@ public String getOpeninvoicedataLineItemNrItemAmount() { } + /** + * The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. + * + * @param openinvoicedataLineItemNrItemAmount + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemAmount(String openinvoicedataLineItemNrItemAmount) { @@ -302,6 +337,11 @@ public String getOpeninvoicedataLineItemNrItemId() { } + /** + * A unique id for this item. Required for RatePay if the description of each item is not unique. + * + * @param openinvoicedataLineItemNrItemId + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemId(String openinvoicedataLineItemNrItemId) { @@ -327,6 +367,11 @@ public String getOpeninvoicedataLineItemNrItemVatAmount() { } + /** + * The VAT due for one item in the invoice line, represented in minor units. + * + * @param openinvoicedataLineItemNrItemVatAmount + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_VAT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemVatAmount(String openinvoicedataLineItemNrItemVatAmount) { @@ -352,6 +397,11 @@ public String getOpeninvoicedataLineItemNrItemVatPercentage() { } + /** + * The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. + * + * @param openinvoicedataLineItemNrItemVatPercentage + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_VAT_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemVatPercentage(String openinvoicedataLineItemNrItemVatPercentage) { @@ -377,6 +427,11 @@ public String getOpeninvoicedataLineItemNrNumberOfItems() { } + /** + * The number of units purchased of a specific product. + * + * @param openinvoicedataLineItemNrNumberOfItems + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_NUMBER_OF_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrNumberOfItems(String openinvoicedataLineItemNrNumberOfItems) { @@ -402,6 +457,11 @@ public String getOpeninvoicedataLineItemNrReturnShippingCompany() { } + /** + * Name of the shipping company handling the the return shipment. + * + * @param openinvoicedataLineItemNrReturnShippingCompany + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_RETURN_SHIPPING_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrReturnShippingCompany(String openinvoicedataLineItemNrReturnShippingCompany) { @@ -427,6 +487,11 @@ public String getOpeninvoicedataLineItemNrReturnTrackingNumber() { } + /** + * The tracking number for the return of the shipment. + * + * @param openinvoicedataLineItemNrReturnTrackingNumber + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_RETURN_TRACKING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrReturnTrackingNumber(String openinvoicedataLineItemNrReturnTrackingNumber) { @@ -452,6 +517,11 @@ public String getOpeninvoicedataLineItemNrReturnTrackingUri() { } + /** + * URI where the customer can track the return of their shipment. + * + * @param openinvoicedataLineItemNrReturnTrackingUri + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_RETURN_TRACKING_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrReturnTrackingUri(String openinvoicedataLineItemNrReturnTrackingUri) { @@ -477,6 +547,11 @@ public String getOpeninvoicedataLineItemNrShippingCompany() { } + /** + * Name of the shipping company handling the delivery. + * + * @param openinvoicedataLineItemNrShippingCompany + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_SHIPPING_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrShippingCompany(String openinvoicedataLineItemNrShippingCompany) { @@ -502,6 +577,11 @@ public String getOpeninvoicedataLineItemNrShippingMethod() { } + /** + * Shipping method. + * + * @param openinvoicedataLineItemNrShippingMethod + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_SHIPPING_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrShippingMethod(String openinvoicedataLineItemNrShippingMethod) { @@ -527,6 +607,11 @@ public String getOpeninvoicedataLineItemNrTrackingNumber() { } + /** + * The tracking number for the shipment. + * + * @param openinvoicedataLineItemNrTrackingNumber + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_TRACKING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrTrackingNumber(String openinvoicedataLineItemNrTrackingNumber) { @@ -552,6 +637,11 @@ public String getOpeninvoicedataLineItemNrTrackingUri() { } + /** + * URI where the customer can track their shipment. + * + * @param openinvoicedataLineItemNrTrackingUri + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_TRACKING_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrTrackingUri(String openinvoicedataLineItemNrTrackingUri) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataOpi.java b/src/main/java/com/adyen/model/checkout/AdditionalDataOpi.java index e2de96cb1..332f262a1 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataOpi.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataOpi.java @@ -59,6 +59,11 @@ public String getOpiIncludeTransToken() { } + /** + * Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + * + * @param opiIncludeTransToken + */ @JsonProperty(JSON_PROPERTY_OPI_INCLUDE_TRANS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpiIncludeTransToken(String opiIncludeTransToken) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataRatepay.java b/src/main/java/com/adyen/model/checkout/AdditionalDataRatepay.java index 191210713..9f321d78f 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataRatepay.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataRatepay.java @@ -87,6 +87,11 @@ public String getRatepayInstallmentAmount() { } + /** + * Amount the customer has to pay each month. + * + * @param ratepayInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_RATEPAY_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayInstallmentAmount(String ratepayInstallmentAmount) { @@ -112,6 +117,11 @@ public String getRatepayInterestRate() { } + /** + * Interest rate of this installment. + * + * @param ratepayInterestRate + */ @JsonProperty(JSON_PROPERTY_RATEPAY_INTEREST_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayInterestRate(String ratepayInterestRate) { @@ -137,6 +147,11 @@ public String getRatepayLastInstallmentAmount() { } + /** + * Amount of the last installment. + * + * @param ratepayLastInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_RATEPAY_LAST_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayLastInstallmentAmount(String ratepayLastInstallmentAmount) { @@ -162,6 +177,11 @@ public String getRatepayPaymentFirstday() { } + /** + * Calendar day of the first payment. + * + * @param ratepayPaymentFirstday + */ @JsonProperty(JSON_PROPERTY_RATEPAY_PAYMENT_FIRSTDAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayPaymentFirstday(String ratepayPaymentFirstday) { @@ -187,6 +207,11 @@ public String getRatepaydataDeliveryDate() { } + /** + * Date the merchant delivered the goods to the customer. + * + * @param ratepaydataDeliveryDate + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataDeliveryDate(String ratepaydataDeliveryDate) { @@ -212,6 +237,11 @@ public String getRatepaydataDueDate() { } + /** + * Date by which the customer must settle the payment. + * + * @param ratepaydataDueDate + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_DUE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataDueDate(String ratepaydataDueDate) { @@ -237,6 +267,11 @@ public String getRatepaydataInvoiceDate() { } + /** + * Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. + * + * @param ratepaydataInvoiceDate + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_INVOICE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataInvoiceDate(String ratepaydataInvoiceDate) { @@ -262,6 +297,11 @@ public String getRatepaydataInvoiceId() { } + /** + * Identification name or number for the invoice, defined by the merchant. + * + * @param ratepaydataInvoiceId + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_INVOICE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataInvoiceId(String ratepaydataInvoiceId) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataRetry.java b/src/main/java/com/adyen/model/checkout/AdditionalDataRetry.java index 90bd64ebc..a4de5c9a1 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataRetry.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataRetry.java @@ -67,6 +67,11 @@ public String getRetryChainAttemptNumber() { } + /** + * The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + * + * @param retryChainAttemptNumber + */ @JsonProperty(JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetryChainAttemptNumber(String retryChainAttemptNumber) { @@ -92,6 +97,11 @@ public String getRetryOrderAttemptNumber() { } + /** + * The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + * + * @param retryOrderAttemptNumber + */ @JsonProperty(JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetryOrderAttemptNumber(String retryOrderAttemptNumber) { @@ -117,6 +127,11 @@ public String getRetrySkipRetry() { } + /** + * The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + * + * @param retrySkipRetry + */ @JsonProperty(JSON_PROPERTY_RETRY_SKIP_RETRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetrySkipRetry(String retrySkipRetry) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataRisk.java b/src/main/java/com/adyen/model/checkout/AdditionalDataRisk.java index df08db25e..856ed5dbe 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataRisk.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataRisk.java @@ -139,6 +139,11 @@ public String getRiskdataCustomFieldName() { } + /** + * The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + * + * @param riskdataCustomFieldName + */ @JsonProperty(JSON_PROPERTY_RISKDATA_CUSTOM_FIELD_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataCustomFieldName(String riskdataCustomFieldName) { @@ -164,6 +169,11 @@ public String getRiskdataBasketItemItemNrAmountPerItem() { } + /** + * The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param riskdataBasketItemItemNrAmountPerItem + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_AMOUNT_PER_ITEM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrAmountPerItem(String riskdataBasketItemItemNrAmountPerItem) { @@ -189,6 +199,11 @@ public String getRiskdataBasketItemItemNrBrand() { } + /** + * Brand of the item. + * + * @param riskdataBasketItemItemNrBrand + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrBrand(String riskdataBasketItemItemNrBrand) { @@ -214,6 +229,11 @@ public String getRiskdataBasketItemItemNrCategory() { } + /** + * Category of the item. + * + * @param riskdataBasketItemItemNrCategory + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrCategory(String riskdataBasketItemItemNrCategory) { @@ -239,6 +259,11 @@ public String getRiskdataBasketItemItemNrColor() { } + /** + * Color of the item. + * + * @param riskdataBasketItemItemNrColor + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrColor(String riskdataBasketItemItemNrColor) { @@ -264,6 +289,11 @@ public String getRiskdataBasketItemItemNrCurrency() { } + /** + * The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param riskdataBasketItemItemNrCurrency + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrCurrency(String riskdataBasketItemItemNrCurrency) { @@ -289,6 +319,11 @@ public String getRiskdataBasketItemItemNrItemID() { } + /** + * ID of the item. + * + * @param riskdataBasketItemItemNrItemID + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_ITEM_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrItemID(String riskdataBasketItemItemNrItemID) { @@ -314,6 +349,11 @@ public String getRiskdataBasketItemItemNrManufacturer() { } + /** + * Manufacturer of the item. + * + * @param riskdataBasketItemItemNrManufacturer + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_MANUFACTURER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrManufacturer(String riskdataBasketItemItemNrManufacturer) { @@ -339,6 +379,11 @@ public String getRiskdataBasketItemItemNrProductTitle() { } + /** + * A text description of the product the invoice line refers to. + * + * @param riskdataBasketItemItemNrProductTitle + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_PRODUCT_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrProductTitle(String riskdataBasketItemItemNrProductTitle) { @@ -364,6 +409,11 @@ public String getRiskdataBasketItemItemNrQuantity() { } + /** + * Quantity of the item purchased. + * + * @param riskdataBasketItemItemNrQuantity + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_QUANTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrQuantity(String riskdataBasketItemItemNrQuantity) { @@ -389,6 +439,11 @@ public String getRiskdataBasketItemItemNrReceiverEmail() { } + /** + * Email associated with the given product in the basket (usually in electronic gift cards). + * + * @param riskdataBasketItemItemNrReceiverEmail + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_RECEIVER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrReceiverEmail(String riskdataBasketItemItemNrReceiverEmail) { @@ -414,6 +469,11 @@ public String getRiskdataBasketItemItemNrSize() { } + /** + * Size of the item. + * + * @param riskdataBasketItemItemNrSize + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrSize(String riskdataBasketItemItemNrSize) { @@ -439,6 +499,11 @@ public String getRiskdataBasketItemItemNrSku() { } + /** + * [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit). + * + * @param riskdataBasketItemItemNrSku + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SKU) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrSku(String riskdataBasketItemItemNrSku) { @@ -464,6 +529,11 @@ public String getRiskdataBasketItemItemNrUpc() { } + /** + * [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code). + * + * @param riskdataBasketItemItemNrUpc + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_UPC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrUpc(String riskdataBasketItemItemNrUpc) { @@ -489,6 +559,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionCode() { } + /** + * Code of the promotion. + * + * @param riskdataPromotionsPromotionItemNrPromotionCode + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionCode(String riskdataPromotionsPromotionItemNrPromotionCode) { @@ -514,6 +589,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionDiscountAmount() { } + /** + * The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param riskdataPromotionsPromotionItemNrPromotionDiscountAmount + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionDiscountAmount(String riskdataPromotionsPromotionItemNrPromotionDiscountAmount) { @@ -539,6 +619,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency() { } + /** + * The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param riskdataPromotionsPromotionItemNrPromotionDiscountCurrency + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency(String riskdataPromotionsPromotionItemNrPromotionDiscountCurrency) { @@ -564,6 +649,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage() } + /** + * Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. e.g. for a promotion discount of 30%, the value of the field should be 30. + * + * @param riskdataPromotionsPromotionItemNrPromotionDiscountPercentage + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage(String riskdataPromotionsPromotionItemNrPromotionDiscountPercentage) { @@ -589,6 +679,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionName() { } + /** + * Name of the promotion. + * + * @param riskdataPromotionsPromotionItemNrPromotionName + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionName(String riskdataPromotionsPromotionItemNrPromotionName) { @@ -614,6 +709,11 @@ public String getRiskdataRiskProfileReference() { } + /** + * Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + * + * @param riskdataRiskProfileReference + */ @JsonProperty(JSON_PROPERTY_RISKDATA_RISK_PROFILE_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataRiskProfileReference(String riskdataRiskProfileReference) { @@ -639,6 +739,11 @@ public String getRiskdataSkipRisk() { } + /** + * If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score. + * + * @param riskdataSkipRisk + */ @JsonProperty(JSON_PROPERTY_RISKDATA_SKIP_RISK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataSkipRisk(String riskdataSkipRisk) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataRiskStandalone.java b/src/main/java/com/adyen/model/checkout/AdditionalDataRiskStandalone.java index 5a935dde8..89ab93619 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataRiskStandalone.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataRiskStandalone.java @@ -115,6 +115,11 @@ public String getPayPalCountryCode() { } + /** + * Shopper's country of residence in the form of ISO standard 3166 2-character country codes. + * + * @param payPalCountryCode + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalCountryCode(String payPalCountryCode) { @@ -140,6 +145,11 @@ public String getPayPalEmailId() { } + /** + * Shopper's email. + * + * @param payPalEmailId + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_EMAIL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalEmailId(String payPalEmailId) { @@ -165,6 +175,11 @@ public String getPayPalFirstName() { } + /** + * Shopper's first name. + * + * @param payPalFirstName + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalFirstName(String payPalFirstName) { @@ -190,6 +205,11 @@ public String getPayPalLastName() { } + /** + * Shopper's last name. + * + * @param payPalLastName + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalLastName(String payPalLastName) { @@ -215,6 +235,11 @@ public String getPayPalPayerId() { } + /** + * Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. + * + * @param payPalPayerId + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_PAYER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalPayerId(String payPalPayerId) { @@ -240,6 +265,11 @@ public String getPayPalPhone() { } + /** + * Shopper's phone number. + * + * @param payPalPhone + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalPhone(String payPalPhone) { @@ -265,6 +295,11 @@ public String getPayPalProtectionEligibility() { } + /** + * Allowed values: * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. * **Ineligible** — Merchant is not protected under the Seller Protection Policy. + * + * @param payPalProtectionEligibility + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_PROTECTION_ELIGIBILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalProtectionEligibility(String payPalProtectionEligibility) { @@ -290,6 +325,11 @@ public String getPayPalTransactionId() { } + /** + * Unique transaction ID of the payment. + * + * @param payPalTransactionId + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalTransactionId(String payPalTransactionId) { @@ -315,6 +355,11 @@ public String getAvsResultRaw() { } + /** + * Raw AVS result received from the acquirer, where available. Example: D + * + * @param avsResultRaw + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResultRaw(String avsResultRaw) { @@ -340,6 +385,11 @@ public String getBin() { } + /** + * The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + * + * @param bin + */ @JsonProperty(JSON_PROPERTY_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBin(String bin) { @@ -365,6 +415,11 @@ public String getCvcResultRaw() { } + /** + * Raw CVC result received from the acquirer, where available. Example: 1 + * + * @param cvcResultRaw + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResultRaw(String cvcResultRaw) { @@ -390,6 +445,11 @@ public String getRiskToken() { } + /** + * Unique identifier or token for the shopper's card details. + * + * @param riskToken + */ @JsonProperty(JSON_PROPERTY_RISK_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskToken(String riskToken) { @@ -415,6 +475,11 @@ public String getThreeDAuthenticated() { } + /** + * A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true + * + * @param threeDAuthenticated + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticated(String threeDAuthenticated) { @@ -440,6 +505,11 @@ public String getThreeDOffered() { } + /** + * A Boolean value indicating whether 3DS was offered for this payment. Example: true + * + * @param threeDOffered + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOffered(String threeDOffered) { @@ -465,6 +535,11 @@ public String getTokenDataType() { } + /** + * Required for PayPal payments only. The only supported value is: **paypal**. + * + * @param tokenDataType + */ @JsonProperty(JSON_PROPERTY_TOKEN_DATA_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenDataType(String tokenDataType) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataSubMerchant.java b/src/main/java/com/adyen/model/checkout/AdditionalDataSubMerchant.java index 22c8267cd..4c28ed3ea 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataSubMerchant.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataSubMerchant.java @@ -95,6 +95,11 @@ public String getSubMerchantNumberOfSubSellers() { } + /** + * Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**. + * + * @param subMerchantNumberOfSubSellers + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_NUMBER_OF_SUB_SELLERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantNumberOfSubSellers(String subMerchantNumberOfSubSellers) { @@ -120,6 +125,11 @@ public String getSubMerchantSubSellerSubSellerNrCity() { } + /** + * Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters + * + * @param subMerchantSubSellerSubSellerNrCity + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrCity(String subMerchantSubSellerSubSellerNrCity) { @@ -145,6 +155,11 @@ public String getSubMerchantSubSellerSubSellerNrCountry() { } + /** + * Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters + * + * @param subMerchantSubSellerSubSellerNrCountry + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrCountry(String subMerchantSubSellerSubSellerNrCountry) { @@ -170,6 +185,11 @@ public String getSubMerchantSubSellerSubSellerNrId() { } + /** + * Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. * Format: Alphanumeric * Maximum length: 15 characters + * + * @param subMerchantSubSellerSubSellerNrId + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrId(String subMerchantSubSellerSubSellerNrId) { @@ -195,6 +215,11 @@ public String getSubMerchantSubSellerSubSellerNrMcc() { } + /** + * Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits + * + * @param subMerchantSubSellerSubSellerNrMcc + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrMcc(String subMerchantSubSellerSubSellerNrMcc) { @@ -220,6 +245,11 @@ public String getSubMerchantSubSellerSubSellerNrName() { } + /** + * Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters + * + * @param subMerchantSubSellerSubSellerNrName + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrName(String subMerchantSubSellerSubSellerNrName) { @@ -245,6 +275,11 @@ public String getSubMerchantSubSellerSubSellerNrPostalCode() { } + /** + * Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes. * Format: Numeric * Fixed length: 8 digits + * + * @param subMerchantSubSellerSubSellerNrPostalCode + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrPostalCode(String subMerchantSubSellerSubSellerNrPostalCode) { @@ -270,6 +305,11 @@ public String getSubMerchantSubSellerSubSellerNrState() { } + /** + * Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country. * Format: Alphanumeric * Maximum length: 2 characters + * + * @param subMerchantSubSellerSubSellerNrState + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrState(String subMerchantSubSellerSubSellerNrState) { @@ -295,6 +335,11 @@ public String getSubMerchantSubSellerSubSellerNrStreet() { } + /** + * Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 60 characters + * + * @param subMerchantSubSellerSubSellerNrStreet + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrStreet(String subMerchantSubSellerSubSellerNrStreet) { @@ -320,6 +365,11 @@ public String getSubMerchantSubSellerSubSellerNrTaxId() { } + /** + * Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ + * + * @param subMerchantSubSellerSubSellerNrTaxId + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrTaxId(String subMerchantSubSellerSubSellerNrTaxId) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataTemporaryServices.java b/src/main/java/com/adyen/model/checkout/AdditionalDataTemporaryServices.java index 0eea994ec..f8a1bdb85 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataTemporaryServices.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataTemporaryServices.java @@ -91,6 +91,11 @@ public String getEnhancedSchemeDataCustomerReference() { } + /** + * The customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25 + * + * @param enhancedSchemeDataCustomerReference + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_CUSTOMER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataCustomerReference(String enhancedSchemeDataCustomerReference) { @@ -116,6 +121,11 @@ public String getEnhancedSchemeDataEmployeeName() { } + /** + * The name or ID of the person working in a temporary capacity. * maxLength: 40. * Must not be all spaces. *Must not be all zeros. + * + * @param enhancedSchemeDataEmployeeName + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_EMPLOYEE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataEmployeeName(String enhancedSchemeDataEmployeeName) { @@ -141,6 +151,11 @@ public String getEnhancedSchemeDataJobDescription() { } + /** + * The job description of the person working in a temporary capacity. * maxLength: 40 * Must not be all spaces. *Must not be all zeros. + * + * @param enhancedSchemeDataJobDescription + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_JOB_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataJobDescription(String enhancedSchemeDataJobDescription) { @@ -166,6 +181,11 @@ public String getEnhancedSchemeDataRegularHoursRate() { } + /** + * The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 7 * Must not be empty * Can be all zeros + * + * @param enhancedSchemeDataRegularHoursRate + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_REGULAR_HOURS_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataRegularHoursRate(String enhancedSchemeDataRegularHoursRate) { @@ -191,6 +211,11 @@ public String getEnhancedSchemeDataRegularHoursWorked() { } + /** + * The hours worked. * maxLength: 7 * Must not be empty * Can be all zeros + * + * @param enhancedSchemeDataRegularHoursWorked + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_REGULAR_HOURS_WORKED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataRegularHoursWorked(String enhancedSchemeDataRegularHoursWorked) { @@ -216,6 +241,11 @@ public String getEnhancedSchemeDataRequestName() { } + /** + * The name of the person requesting temporary services. * maxLength: 40 * Must not be all zeros * Must not be all spaces + * + * @param enhancedSchemeDataRequestName + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_REQUEST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataRequestName(String enhancedSchemeDataRequestName) { @@ -241,6 +271,11 @@ public String getEnhancedSchemeDataTempStartDate() { } + /** + * The billing period start date. * Format: ddMMyy * maxLength: 6 + * + * @param enhancedSchemeDataTempStartDate + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TEMP_START_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTempStartDate(String enhancedSchemeDataTempStartDate) { @@ -266,6 +301,11 @@ public String getEnhancedSchemeDataTempWeekEnding() { } + /** + * The billing period end date. * Format: ddMMyy * maxLength: 6 + * + * @param enhancedSchemeDataTempWeekEnding + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TEMP_WEEK_ENDING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTempWeekEnding(String enhancedSchemeDataTempWeekEnding) { @@ -291,6 +331,11 @@ public String getEnhancedSchemeDataTotalTaxAmount() { } + /** + * The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00 * maxLength: 12 + * + * @param enhancedSchemeDataTotalTaxAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TOTAL_TAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTotalTaxAmount(String enhancedSchemeDataTotalTaxAmount) { diff --git a/src/main/java/com/adyen/model/checkout/AdditionalDataWallets.java b/src/main/java/com/adyen/model/checkout/AdditionalDataWallets.java index 8c4d44b76..fa4db2b84 100644 --- a/src/main/java/com/adyen/model/checkout/AdditionalDataWallets.java +++ b/src/main/java/com/adyen/model/checkout/AdditionalDataWallets.java @@ -79,6 +79,11 @@ public String getAndroidpayToken() { } + /** + * The Android Pay token retrieved from the SDK. + * + * @param androidpayToken + */ @JsonProperty(JSON_PROPERTY_ANDROIDPAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAndroidpayToken(String androidpayToken) { @@ -104,6 +109,11 @@ public String getMasterpassTransactionId() { } + /** + * The Mastercard Masterpass Transaction ID retrieved from the SDK. + * + * @param masterpassTransactionId + */ @JsonProperty(JSON_PROPERTY_MASTERPASS_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMasterpassTransactionId(String masterpassTransactionId) { @@ -129,6 +139,11 @@ public String getPaymentToken() { } + /** + * The Apple Pay token retrieved from the SDK. + * + * @param paymentToken + */ @JsonProperty(JSON_PROPERTY_PAYMENT_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentToken(String paymentToken) { @@ -154,6 +169,11 @@ public String getPaywithgoogleToken() { } + /** + * The Google Pay token retrieved from the SDK. + * + * @param paywithgoogleToken + */ @JsonProperty(JSON_PROPERTY_PAYWITHGOOGLE_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaywithgoogleToken(String paywithgoogleToken) { @@ -179,6 +199,11 @@ public String getSamsungpayToken() { } + /** + * The Samsung Pay token retrieved from the SDK. + * + * @param samsungpayToken + */ @JsonProperty(JSON_PROPERTY_SAMSUNGPAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSamsungpayToken(String samsungpayToken) { @@ -204,6 +229,11 @@ public String getVisacheckoutCallId() { } + /** + * The Visa Checkout Call ID retrieved from the SDK. + * + * @param visacheckoutCallId + */ @JsonProperty(JSON_PROPERTY_VISACHECKOUT_CALL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisacheckoutCallId(String visacheckoutCallId) { diff --git a/src/main/java/com/adyen/model/checkout/Address.java b/src/main/java/com/adyen/model/checkout/Address.java index 7d715b014..48b0fe0a8 100644 --- a/src/main/java/com/adyen/model/checkout/Address.java +++ b/src/main/java/com/adyen/model/checkout/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -154,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -179,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -204,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/checkout/AfterpayDetails.java b/src/main/java/com/adyen/model/checkout/AfterpayDetails.java index b0b5ca431..0731918c9 100644 --- a/src/main/java/com/adyen/model/checkout/AfterpayDetails.java +++ b/src/main/java/com/adyen/model/checkout/AfterpayDetails.java @@ -122,6 +122,11 @@ public String getBillingAddress() { } + /** + * The address where to send the invoice. + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(String billingAddress) { @@ -147,6 +152,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -172,6 +182,11 @@ public String getDeliveryAddress() { } + /** + * The address where the goods should be delivered. + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(String deliveryAddress) { @@ -197,6 +212,11 @@ public String getPersonalDetails() { } + /** + * Shopper name, date of birth, phone number, and email address. + * + * @param personalDetails + */ @JsonProperty(JSON_PROPERTY_PERSONAL_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPersonalDetails(String personalDetails) { @@ -224,6 +244,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -250,6 +275,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -275,6 +305,11 @@ public TypeEnum getType() { } + /** + * **afterpay_default** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/AmazonPayDetails.java b/src/main/java/com/adyen/model/checkout/AmazonPayDetails.java index b5d2b11f0..6c907d7d4 100644 --- a/src/main/java/com/adyen/model/checkout/AmazonPayDetails.java +++ b/src/main/java/com/adyen/model/checkout/AmazonPayDetails.java @@ -104,6 +104,11 @@ public String getAmazonPayToken() { } + /** + * This is the `amazonPayToken` that you obtained from the [Get Checkout Session](https://amazon-pay-acquirer-guide.s3-eu-west-1.amazonaws.com/v1/amazon-pay-api-v2/checkout-session.html#get-checkout-session) response. This token is used for API only integration specifically. + * + * @param amazonPayToken + */ @JsonProperty(JSON_PROPERTY_AMAZON_PAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmazonPayToken(String amazonPayToken) { @@ -129,6 +134,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -154,6 +164,11 @@ public String getCheckoutSessionId() { } + /** + * The `checkoutSessionId` is used to identify the checkout session at the Amazon Pay side. This field is required only for drop-in and components integration, where it replaces the amazonPayToken. + * + * @param checkoutSessionId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_SESSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutSessionId(String checkoutSessionId) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **amazonpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/Amount.java b/src/main/java/com/adyen/model/checkout/Amount.java index c02d311a8..b720464cf 100644 --- a/src/main/java/com/adyen/model/checkout/Amount.java +++ b/src/main/java/com/adyen/model/checkout/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/checkout/AndroidPayDetails.java b/src/main/java/com/adyen/model/checkout/AndroidPayDetails.java index b8f2813d9..9612521c8 100644 --- a/src/main/java/com/adyen/model/checkout/AndroidPayDetails.java +++ b/src/main/java/com/adyen/model/checkout/AndroidPayDetails.java @@ -96,6 +96,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **androidpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/ApplePayDetails.java b/src/main/java/com/adyen/model/checkout/ApplePayDetails.java index 07862158b..5b325187a 100644 --- a/src/main/java/com/adyen/model/checkout/ApplePayDetails.java +++ b/src/main/java/com/adyen/model/checkout/ApplePayDetails.java @@ -147,6 +147,11 @@ public String getApplePayToken() { } + /** + * The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + * + * @param applePayToken + */ @JsonProperty(JSON_PROPERTY_APPLE_PAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplePayToken(String applePayToken) { @@ -172,6 +177,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -197,6 +207,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -224,6 +239,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -250,6 +270,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -275,6 +300,11 @@ public TypeEnum getType() { } + /** + * **applepay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/ApplePayDonations.java b/src/main/java/com/adyen/model/checkout/ApplePayDonations.java new file mode 100644 index 000000000..9c220bf49 --- /dev/null +++ b/src/main/java/com/adyen/model/checkout/ApplePayDonations.java @@ -0,0 +1,384 @@ +/* + * Adyen Checkout API + * + * The version of the OpenAPI document: 71 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.checkout; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * ApplePayDonations + */ +@JsonPropertyOrder({ + ApplePayDonations.JSON_PROPERTY_APPLE_PAY_TOKEN, + ApplePayDonations.JSON_PROPERTY_CHECKOUT_ATTEMPT_ID, + ApplePayDonations.JSON_PROPERTY_FUNDING_SOURCE, + ApplePayDonations.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE, + ApplePayDonations.JSON_PROPERTY_STORED_PAYMENT_METHOD_ID, + ApplePayDonations.JSON_PROPERTY_TYPE +}) + +public class ApplePayDonations { + public static final String JSON_PROPERTY_APPLE_PAY_TOKEN = "applePayToken"; + private String applePayToken; + + public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID = "checkoutAttemptId"; + private String checkoutAttemptId; + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + */ + public enum FundingSourceEnum { + CREDIT("credit"), + + DEBIT("debit"); + + private String value; + + FundingSourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FundingSourceEnum fromValue(String value) { + for (FundingSourceEnum b : FundingSourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FUNDING_SOURCE = "fundingSource"; + private FundingSourceEnum fundingSource; + + public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE = "recurringDetailReference"; + private String recurringDetailReference; + + public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID = "storedPaymentMethodId"; + private String storedPaymentMethodId; + + /** + * **applepay** + */ + public enum TypeEnum { + APPLEPAY("applepay"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TypeEnum fromValue(String value) { + for (TypeEnum b : TypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TYPE = "type"; + private TypeEnum type = TypeEnum.APPLEPAY; + + public ApplePayDonations() { + } + + public ApplePayDonations applePayToken(String applePayToken) { + this.applePayToken = applePayToken; + return this; + } + + /** + * The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + * @return applePayToken + **/ + @ApiModelProperty(required = true, value = "The stringified and base64 encoded `paymentData` you retrieved from the Apple framework.") + @JsonProperty(JSON_PROPERTY_APPLE_PAY_TOKEN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getApplePayToken() { + return applePayToken; + } + + + /** + * The stringified and base64 encoded `paymentData` you retrieved from the Apple framework. + * + * @param applePayToken + */ + @JsonProperty(JSON_PROPERTY_APPLE_PAY_TOKEN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setApplePayToken(String applePayToken) { + this.applePayToken = applePayToken; + } + + + public ApplePayDonations checkoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + return this; + } + + /** + * The checkout attempt identifier. + * @return checkoutAttemptId + **/ + @ApiModelProperty(value = "The checkout attempt identifier.") + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCheckoutAttemptId() { + return checkoutAttemptId; + } + + + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCheckoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + } + + + public ApplePayDonations fundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + return this; + } + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * @return fundingSource + **/ + @ApiModelProperty(value = "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.") + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FundingSourceEnum getFundingSource() { + return fundingSource; + } + + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + } + + + public ApplePayDonations recurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return recurringDetailReference + * @deprecated + **/ + @Deprecated + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getRecurringDetailReference() { + return recurringDetailReference; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ + @Deprecated + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setRecurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + } + + + public ApplePayDonations storedPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return storedPaymentMethodId + **/ + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStoredPaymentMethodId() { + return storedPaymentMethodId; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setStoredPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + } + + + public ApplePayDonations type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * **applepay** + * @return type + **/ + @ApiModelProperty(value = "**applepay**") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TypeEnum getType() { + return type; + } + + + /** + * **applepay** + * + * @param type + */ + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(TypeEnum type) { + this.type = type; + } + + + /** + * Return true if this ApplePayDonations object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + ApplePayDonations applePayDonations = (ApplePayDonations) o; + return Objects.equals(this.applePayToken, applePayDonations.applePayToken) && + Objects.equals(this.checkoutAttemptId, applePayDonations.checkoutAttemptId) && + Objects.equals(this.fundingSource, applePayDonations.fundingSource) && + Objects.equals(this.recurringDetailReference, applePayDonations.recurringDetailReference) && + Objects.equals(this.storedPaymentMethodId, applePayDonations.storedPaymentMethodId) && + Objects.equals(this.type, applePayDonations.type); + } + + @Override + public int hashCode() { + return Objects.hash(applePayToken, checkoutAttemptId, fundingSource, recurringDetailReference, storedPaymentMethodId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class ApplePayDonations {\n"); + sb.append(" applePayToken: ").append(toIndentedString(applePayToken)).append("\n"); + sb.append(" checkoutAttemptId: ").append(toIndentedString(checkoutAttemptId)).append("\n"); + sb.append(" fundingSource: ").append(toIndentedString(fundingSource)).append("\n"); + sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n"); + sb.append(" storedPaymentMethodId: ").append(toIndentedString(storedPaymentMethodId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of ApplePayDonations given an JSON string + * + * @param jsonString JSON string + * @return An instance of ApplePayDonations + * @throws JsonProcessingException if the JSON string is invalid with respect to ApplePayDonations + */ + public static ApplePayDonations fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, ApplePayDonations.class); + } +/** + * Convert an instance of ApplePayDonations to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/checkout/ApplePaySessionRequest.java b/src/main/java/com/adyen/model/checkout/ApplePaySessionRequest.java index 937902cb5..1d888c259 100644 --- a/src/main/java/com/adyen/model/checkout/ApplePaySessionRequest.java +++ b/src/main/java/com/adyen/model/checkout/ApplePaySessionRequest.java @@ -67,6 +67,11 @@ public String getDisplayName() { } + /** + * This is the name that your shoppers will see in the Apple Pay interface. The value returned as `configuration.merchantName` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response. + * + * @param displayName + */ @JsonProperty(JSON_PROPERTY_DISPLAY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisplayName(String displayName) { @@ -92,6 +97,11 @@ public String getDomainName() { } + /** + * The domain name you provided when you added Apple Pay in your Customer Area. This must match the `window.location.hostname` of the web shop. + * + * @param domainName + */ @JsonProperty(JSON_PROPERTY_DOMAIN_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomainName(String domainName) { @@ -117,6 +127,11 @@ public String getMerchantIdentifier() { } + /** + * Your merchant identifier registered with Apple Pay. Use the value of the `configuration.merchantId` field from the [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response. + * + * @param merchantIdentifier + */ @JsonProperty(JSON_PROPERTY_MERCHANT_IDENTIFIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantIdentifier(String merchantIdentifier) { diff --git a/src/main/java/com/adyen/model/checkout/ApplePaySessionResponse.java b/src/main/java/com/adyen/model/checkout/ApplePaySessionResponse.java index ac605b78f..74c693dbd 100644 --- a/src/main/java/com/adyen/model/checkout/ApplePaySessionResponse.java +++ b/src/main/java/com/adyen/model/checkout/ApplePaySessionResponse.java @@ -59,6 +59,11 @@ public String getData() { } + /** + * Base64 encoded data you need to [complete the Apple Pay merchant validation](https://docs.adyen.com/payment-methods/apple-pay/api-only?tab=adyen-certificate-validation_1#complete-apple-pay-session-validation). + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(String data) { diff --git a/src/main/java/com/adyen/model/checkout/ApplicationInfo.java b/src/main/java/com/adyen/model/checkout/ApplicationInfo.java index c02db5035..58f257715 100644 --- a/src/main/java/com/adyen/model/checkout/ApplicationInfo.java +++ b/src/main/java/com/adyen/model/checkout/ApplicationInfo.java @@ -83,6 +83,11 @@ public CommonField getAdyenLibrary() { } + /** + * adyenLibrary + * + * @param adyenLibrary + */ @JsonProperty(JSON_PROPERTY_ADYEN_LIBRARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenLibrary(CommonField adyenLibrary) { @@ -108,6 +113,11 @@ public CommonField getAdyenPaymentSource() { } + /** + * adyenPaymentSource + * + * @param adyenPaymentSource + */ @JsonProperty(JSON_PROPERTY_ADYEN_PAYMENT_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenPaymentSource(CommonField adyenPaymentSource) { @@ -133,6 +143,11 @@ public ExternalPlatform getExternalPlatform() { } + /** + * externalPlatform + * + * @param externalPlatform + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalPlatform(ExternalPlatform externalPlatform) { @@ -158,6 +173,11 @@ public CommonField getMerchantApplication() { } + /** + * merchantApplication + * + * @param merchantApplication + */ @JsonProperty(JSON_PROPERTY_MERCHANT_APPLICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantApplication(CommonField merchantApplication) { @@ -183,6 +203,11 @@ public MerchantDevice getMerchantDevice() { } + /** + * merchantDevice + * + * @param merchantDevice + */ @JsonProperty(JSON_PROPERTY_MERCHANT_DEVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantDevice(MerchantDevice merchantDevice) { @@ -208,6 +233,11 @@ public ShopperInteractionDevice getShopperInteractionDevice() { } + /** + * shopperInteractionDevice + * + * @param shopperInteractionDevice + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION_DEVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteractionDevice(ShopperInteractionDevice shopperInteractionDevice) { diff --git a/src/main/java/com/adyen/model/checkout/AuthenticationData.java b/src/main/java/com/adyen/model/checkout/AuthenticationData.java index a605264ea..785a9d360 100644 --- a/src/main/java/com/adyen/model/checkout/AuthenticationData.java +++ b/src/main/java/com/adyen/model/checkout/AuthenticationData.java @@ -103,6 +103,11 @@ public AttemptAuthenticationEnum getAttemptAuthentication() { } + /** + * Indicates when 3D Secure authentication should be attempted. This overrides all other rules, including [Dynamic 3D Secure settings](https://docs.adyen.com/risk-management/dynamic-3d-secure). Possible values: * **always**: Perform 3D Secure authentication. * **never**: Don't perform 3D Secure authentication. If PSD2 SCA or other national regulations require authentication, the transaction gets declined. + * + * @param attemptAuthentication + */ @JsonProperty(JSON_PROPERTY_ATTEMPT_AUTHENTICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAttemptAuthentication(AttemptAuthenticationEnum attemptAuthentication) { @@ -128,6 +133,11 @@ public Boolean getAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. Default: **false**. + * + * @param authenticationOnly + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationOnly(Boolean authenticationOnly) { @@ -153,6 +163,11 @@ public ThreeDSRequestData getThreeDSRequestData() { } + /** + * threeDSRequestData + * + * @param threeDSRequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestData(ThreeDSRequestData threeDSRequestData) { diff --git a/src/main/java/com/adyen/model/checkout/Avs.java b/src/main/java/com/adyen/model/checkout/Avs.java index 5fb6a13ca..8528e82e5 100644 --- a/src/main/java/com/adyen/model/checkout/Avs.java +++ b/src/main/java/com/adyen/model/checkout/Avs.java @@ -100,6 +100,11 @@ public Boolean getAddressEditable() { } + /** + * Indicates whether the shopper is allowed to modify the billing address for the current payment request. + * + * @param addressEditable + */ @JsonProperty(JSON_PROPERTY_ADDRESS_EDITABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddressEditable(Boolean addressEditable) { @@ -125,6 +130,11 @@ public EnabledEnum getEnabled() { } + /** + * Specifies whether the shopper should enter their billing address during checkout. Allowed values: * yes — Perform AVS checks for every card payment. * automatic — Perform AVS checks only when required to optimize the conversion rate. * no — Do not perform AVS checks. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(EnabledEnum enabled) { diff --git a/src/main/java/com/adyen/model/checkout/BacsDirectDebitDetails.java b/src/main/java/com/adyen/model/checkout/BacsDirectDebitDetails.java index bcc10373e..01190240b 100644 --- a/src/main/java/com/adyen/model/checkout/BacsDirectDebitDetails.java +++ b/src/main/java/com/adyen/model/checkout/BacsDirectDebitDetails.java @@ -116,6 +116,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -141,6 +146,11 @@ public String getBankLocationId() { } + /** + * The bank routing number of the account. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -166,6 +176,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -191,6 +206,11 @@ public String getHolderName() { } + /** + * The name of the bank account holder. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -218,6 +238,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -244,6 +269,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -269,6 +299,11 @@ public TypeEnum getType() { } + /** + * **directdebit_GB** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/BalanceCheckRequest.java b/src/main/java/com/adyen/model/checkout/BalanceCheckRequest.java index 14b67c607..68fd386e7 100644 --- a/src/main/java/com/adyen/model/checkout/BalanceCheckRequest.java +++ b/src/main/java/com/adyen/model/checkout/BalanceCheckRequest.java @@ -325,6 +325,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -350,6 +355,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -383,6 +393,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -408,6 +423,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -433,6 +453,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -458,6 +483,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -483,6 +513,11 @@ public BrowserInfo getBrowserInfo() { } + /** + * browserInfo + * + * @param browserInfo + */ @JsonProperty(JSON_PROPERTY_BROWSER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrowserInfo(BrowserInfo browserInfo) { @@ -508,6 +543,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -533,6 +573,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -558,6 +603,11 @@ public ForexQuote getDccQuote() { } + /** + * dccQuote + * + * @param dccQuote + */ @JsonProperty(JSON_PROPERTY_DCC_QUOTE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccQuote(ForexQuote dccQuote) { @@ -583,6 +633,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -608,6 +663,11 @@ public OffsetDateTime getDeliveryDate() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliveryDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryDate(OffsetDateTime deliveryDate) { @@ -633,6 +693,11 @@ public String getDeviceFingerprint() { } + /** + * A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + * + * @param deviceFingerprint + */ @JsonProperty(JSON_PROPERTY_DEVICE_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceFingerprint(String deviceFingerprint) { @@ -658,6 +723,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -683,6 +753,11 @@ public Installments getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Installments installments) { @@ -716,6 +791,11 @@ public Map getLocalizedShopperStatement() { } + /** + * The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. + * + * @param localizedShopperStatement + */ @JsonProperty(JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalizedShopperStatement(Map localizedShopperStatement) { @@ -741,6 +821,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -766,6 +851,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -791,6 +881,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -816,6 +911,11 @@ public MerchantRiskIndicator getMerchantRiskIndicator() { } + /** + * merchantRiskIndicator + * + * @param merchantRiskIndicator + */ @JsonProperty(JSON_PROPERTY_MERCHANT_RISK_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) { @@ -849,6 +949,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -874,6 +979,11 @@ public String getOrderReference() { } + /** + * When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + * + * @param orderReference + */ @JsonProperty(JSON_PROPERTY_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderReference(String orderReference) { @@ -904,6 +1014,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information. + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -929,6 +1044,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -954,6 +1074,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -979,6 +1104,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1004,6 +1134,11 @@ public String getSelectedBrand() { } + /** + * Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card. + * + * @param selectedBrand + */ @JsonProperty(JSON_PROPERTY_SELECTED_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedBrand(String selectedBrand) { @@ -1029,6 +1164,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -1054,6 +1194,11 @@ public String getSessionId() { } + /** + * A session ID used to identify a payment session. + * + * @param sessionId + */ @JsonProperty(JSON_PROPERTY_SESSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionId(String sessionId) { @@ -1079,6 +1224,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1104,6 +1254,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1129,6 +1284,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1154,6 +1314,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1179,6 +1344,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1204,6 +1374,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1229,6 +1404,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1254,6 +1434,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1287,6 +1472,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1312,6 +1502,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1337,6 +1532,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1362,6 +1562,11 @@ public ThreeDS2RequestData getThreeDS2RequestData() { } + /** + * threeDS2RequestData + * + * @param threeDS2RequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData) { @@ -1389,6 +1594,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -1415,6 +1625,11 @@ public String getTotalsGroup() { } + /** + * The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). + * + * @param totalsGroup + */ @JsonProperty(JSON_PROPERTY_TOTALS_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalsGroup(String totalsGroup) { @@ -1440,6 +1655,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { diff --git a/src/main/java/com/adyen/model/checkout/BalanceCheckResponse.java b/src/main/java/com/adyen/model/checkout/BalanceCheckResponse.java index 649441550..b6704cc46 100644 --- a/src/main/java/com/adyen/model/checkout/BalanceCheckResponse.java +++ b/src/main/java/com/adyen/model/checkout/BalanceCheckResponse.java @@ -133,6 +133,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -158,6 +163,11 @@ public Amount getBalance() { } + /** + * balance + * + * @param balance + */ @JsonProperty(JSON_PROPERTY_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalance(Amount balance) { @@ -183,6 +193,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -208,6 +223,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -233,6 +253,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -258,6 +283,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the cancellation request. Possible values: * **Success** – Indicates that the balance check was successful. * **NotEnoughBalance** – Commonly indicates that the card did not have enough balance to pay the amount in the request, or that the currency of the balance on the card did not match the currency of the requested amount. * **Failed** – Indicates that the balance check failed. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -283,6 +313,11 @@ public Amount getTransactionLimit() { } + /** + * transactionLimit + * + * @param transactionLimit + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_LIMIT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionLimit(Amount transactionLimit) { diff --git a/src/main/java/com/adyen/model/checkout/BankAccount.java b/src/main/java/com/adyen/model/checkout/BankAccount.java index 451e3d58b..f7c21274b 100644 --- a/src/main/java/com/adyen/model/checkout/BankAccount.java +++ b/src/main/java/com/adyen/model/checkout/BankAccount.java @@ -91,6 +91,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -116,6 +121,11 @@ public String getBankCity() { } + /** + * The bank city. + * + * @param bankCity + */ @JsonProperty(JSON_PROPERTY_BANK_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCity(String bankCity) { @@ -141,6 +151,11 @@ public String getBankLocationId() { } + /** + * The location id of the bank. The field value is `nil` in most cases. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -166,6 +181,11 @@ public String getBankName() { } + /** + * The name of the bank. + * + * @param bankName + */ @JsonProperty(JSON_PROPERTY_BANK_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankName(String bankName) { @@ -191,6 +211,11 @@ public String getBic() { } + /** + * The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -216,6 +241,11 @@ public String getCountryCode() { } + /** + * Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL'). + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -241,6 +271,11 @@ public String getIban() { } + /** + * The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -266,6 +301,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -291,6 +331,11 @@ public String getTaxId() { } + /** + * The bank account holder's tax ID. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/checkout/BillDeskDetails.java b/src/main/java/com/adyen/model/checkout/BillDeskDetails.java index 3ab33950e..3d14236c6 100644 --- a/src/main/java/com/adyen/model/checkout/BillDeskDetails.java +++ b/src/main/java/com/adyen/model/checkout/BillDeskDetails.java @@ -47,13 +47,9 @@ public class BillDeskDetails { * **billdesk** */ public enum TypeEnum { - BILLDESK_ONLINE("billdesk_online"), + ONLINE("billdesk_online"), - BILLDESK_WALLET("billdesk_wallet"), - - ONLINEBANKING_IN("onlinebanking_IN"), - - WALLET_IN("wallet_IN"); + WALLET("billdesk_wallet"); private String value; @@ -106,6 +102,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -131,6 +132,11 @@ public String getIssuer() { } + /** + * The issuer id of the shopper's selected bank. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -156,6 +162,11 @@ public TypeEnum getType() { } + /** + * **billdesk** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/BillingAddress.java b/src/main/java/com/adyen/model/checkout/BillingAddress.java index 61e15c9c8..5a22da692 100644 --- a/src/main/java/com/adyen/model/checkout/BillingAddress.java +++ b/src/main/java/com/adyen/model/checkout/BillingAddress.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -154,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -179,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -204,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/checkout/BlikDetails.java b/src/main/java/com/adyen/model/checkout/BlikDetails.java index 62df77fa7..3f99c9698 100644 --- a/src/main/java/com/adyen/model/checkout/BlikDetails.java +++ b/src/main/java/com/adyen/model/checkout/BlikDetails.java @@ -108,6 +108,11 @@ public String getBlikCode() { } + /** + * BLIK code consisting of 6 digits. + * + * @param blikCode + */ @JsonProperty(JSON_PROPERTY_BLIK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlikCode(String blikCode) { @@ -133,6 +138,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -160,6 +170,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -186,6 +201,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -211,6 +231,11 @@ public TypeEnum getType() { } + /** + * **blik** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/BrowserInfo.java b/src/main/java/com/adyen/model/checkout/BrowserInfo.java index 15632f717..ed471cf33 100644 --- a/src/main/java/com/adyen/model/checkout/BrowserInfo.java +++ b/src/main/java/com/adyen/model/checkout/BrowserInfo.java @@ -91,6 +91,11 @@ public String getAcceptHeader() { } + /** + * The accept header value of the shopper's browser. + * + * @param acceptHeader + */ @JsonProperty(JSON_PROPERTY_ACCEPT_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptHeader(String acceptHeader) { @@ -116,6 +121,11 @@ public Integer getColorDepth() { } + /** + * The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. + * + * @param colorDepth + */ @JsonProperty(JSON_PROPERTY_COLOR_DEPTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setColorDepth(Integer colorDepth) { @@ -141,6 +151,11 @@ public Boolean getJavaEnabled() { } + /** + * Boolean value indicating if the shopper's browser is able to execute Java. + * + * @param javaEnabled + */ @JsonProperty(JSON_PROPERTY_JAVA_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJavaEnabled(Boolean javaEnabled) { @@ -166,6 +181,11 @@ public Boolean getJavaScriptEnabled() { } + /** + * Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. + * + * @param javaScriptEnabled + */ @JsonProperty(JSON_PROPERTY_JAVA_SCRIPT_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJavaScriptEnabled(Boolean javaScriptEnabled) { @@ -191,6 +211,11 @@ public String getLanguage() { } + /** + * The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -216,6 +241,11 @@ public Integer getScreenHeight() { } + /** + * The total height of the shopper's device screen in pixels. + * + * @param screenHeight + */ @JsonProperty(JSON_PROPERTY_SCREEN_HEIGHT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScreenHeight(Integer screenHeight) { @@ -241,6 +271,11 @@ public Integer getScreenWidth() { } + /** + * The total width of the shopper's device screen in pixels. + * + * @param screenWidth + */ @JsonProperty(JSON_PROPERTY_SCREEN_WIDTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScreenWidth(Integer screenWidth) { @@ -266,6 +301,11 @@ public Integer getTimeZoneOffset() { } + /** + * Time difference between UTC time and the shopper's browser local time, in minutes. + * + * @param timeZoneOffset + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneOffset(Integer timeZoneOffset) { @@ -291,6 +331,11 @@ public String getUserAgent() { } + /** + * The user agent value of the shopper's browser. + * + * @param userAgent + */ @JsonProperty(JSON_PROPERTY_USER_AGENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUserAgent(String userAgent) { diff --git a/src/main/java/com/adyen/model/checkout/CancelOrderRequest.java b/src/main/java/com/adyen/model/checkout/CancelOrderRequest.java index 4ab12a32f..16047f5dd 100644 --- a/src/main/java/com/adyen/model/checkout/CancelOrderRequest.java +++ b/src/main/java/com/adyen/model/checkout/CancelOrderRequest.java @@ -64,6 +64,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier that orderData belongs to. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -89,6 +94,11 @@ public EncryptedOrderData getOrder() { } + /** + * order + * + * @param order + */ @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrder(EncryptedOrderData order) { diff --git a/src/main/java/com/adyen/model/checkout/CancelOrderResponse.java b/src/main/java/com/adyen/model/checkout/CancelOrderResponse.java index 7c0809c47..d382aaae6 100644 --- a/src/main/java/com/adyen/model/checkout/CancelOrderResponse.java +++ b/src/main/java/com/adyen/model/checkout/CancelOrderResponse.java @@ -96,6 +96,11 @@ public String getPspReference() { } + /** + * A unique reference of the cancellation request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -121,6 +126,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the cancellation request. Possible values: * **Received** – Indicates the cancellation has successfully been received by Adyen, and will be processed. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { diff --git a/src/main/java/com/adyen/model/checkout/Card.java b/src/main/java/com/adyen/model/checkout/Card.java index 4f72bd25b..b83dcc00e 100644 --- a/src/main/java/com/adyen/model/checkout/Card.java +++ b/src/main/java/com/adyen/model/checkout/Card.java @@ -87,6 +87,11 @@ public String getCvc() { } + /** + * The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 – length: 3 digits * CID – length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -112,6 +117,11 @@ public String getExpiryMonth() { } + /** + * The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -137,6 +147,11 @@ public String getExpiryYear() { } + /** + * The card expiry year. Format: 4 digits. For example: 2020 + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -162,6 +177,11 @@ public String getHolderName() { } + /** + * The name of the cardholder, as printed on the card. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -187,6 +207,11 @@ public String getIssueNumber() { } + /** + * The issue number of the card (for some UK debit cards only). + * + * @param issueNumber + */ @JsonProperty(JSON_PROPERTY_ISSUE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssueNumber(String issueNumber) { @@ -212,6 +237,11 @@ public String getNumber() { } + /** + * The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -237,6 +267,11 @@ public String getStartMonth() { } + /** + * The month component of the start date (for some UK debit cards only). + * + * @param startMonth + */ @JsonProperty(JSON_PROPERTY_START_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartMonth(String startMonth) { @@ -262,6 +297,11 @@ public String getStartYear() { } + /** + * The year component of the start date (for some UK debit cards only). + * + * @param startYear + */ @JsonProperty(JSON_PROPERTY_START_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartYear(String startYear) { diff --git a/src/main/java/com/adyen/model/checkout/CardBrandDetails.java b/src/main/java/com/adyen/model/checkout/CardBrandDetails.java index 37dbecb8f..1308c4248 100644 --- a/src/main/java/com/adyen/model/checkout/CardBrandDetails.java +++ b/src/main/java/com/adyen/model/checkout/CardBrandDetails.java @@ -63,6 +63,11 @@ public Boolean getSupported() { } + /** + * Indicates if you support the card brand. + * + * @param supported + */ @JsonProperty(JSON_PROPERTY_SUPPORTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupported(Boolean supported) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * The name of the card brand. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/CardDetails.java b/src/main/java/com/adyen/model/checkout/CardDetails.java index f13b1a08e..09dbb65da 100644 --- a/src/main/java/com/adyen/model/checkout/CardDetails.java +++ b/src/main/java/com/adyen/model/checkout/CardDetails.java @@ -146,10 +146,14 @@ public static FundingSourceEnum fromValue(String value) { * Default payment method details. Common for scheme payment methods, and for simple payment method details. */ public enum TypeEnum { + BCMC("bcmc"), + SCHEME("scheme"), NETWORKTOKEN("networkToken"), + GIFTCARD("giftcard"), + CARD("card"); private String value; @@ -203,6 +207,11 @@ public String getBrand() { } + /** + * Secondary brand of the card. For example: **plastix**, **hmclub**. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -228,6 +237,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -255,6 +269,11 @@ public String getCupsecureplusSmscode() { } + /** + * cupsecureplusSmscode + * + * @param cupsecureplusSmscode + */ @Deprecated @JsonProperty(JSON_PROPERTY_CUPSECUREPLUS_SMSCODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -281,6 +300,11 @@ public String getCvc() { } + /** + * The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -306,6 +330,11 @@ public String getEncryptedCardNumber() { } + /** + * The encrypted card number. + * + * @param encryptedCardNumber + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedCardNumber(String encryptedCardNumber) { @@ -331,6 +360,11 @@ public String getEncryptedExpiryMonth() { } + /** + * The encrypted card expiry month. + * + * @param encryptedExpiryMonth + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedExpiryMonth(String encryptedExpiryMonth) { @@ -356,6 +390,11 @@ public String getEncryptedExpiryYear() { } + /** + * The encrypted card expiry year. + * + * @param encryptedExpiryYear + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedExpiryYear(String encryptedExpiryYear) { @@ -381,6 +420,11 @@ public String getEncryptedSecurityCode() { } + /** + * The encrypted card verification code. + * + * @param encryptedSecurityCode + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_SECURITY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedSecurityCode(String encryptedSecurityCode) { @@ -406,6 +450,11 @@ public String getExpiryMonth() { } + /** + * The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -431,6 +480,11 @@ public String getExpiryYear() { } + /** + * The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -456,6 +510,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -481,6 +540,11 @@ public String getHolderName() { } + /** + * The name of the card holder. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -506,6 +570,11 @@ public String getNetworkPaymentReference() { } + /** + * The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. + * + * @param networkPaymentReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_PAYMENT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkPaymentReference(String networkPaymentReference) { @@ -531,6 +600,11 @@ public String getNumber() { } + /** + * The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -558,6 +632,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -584,6 +663,11 @@ public String getShopperNotificationReference() { } + /** + * The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. + * + * @param shopperNotificationReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperNotificationReference(String shopperNotificationReference) { @@ -609,6 +693,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -634,6 +723,11 @@ public String getThreeDS2SdkVersion() { } + /** + * Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. + * + * @param threeDS2SdkVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_SDK_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2SdkVersion(String threeDS2SdkVersion) { @@ -659,6 +753,11 @@ public TypeEnum getType() { } + /** + * Default payment method details. Common for scheme payment methods, and for simple payment method details. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/CardDetailsRequest.java b/src/main/java/com/adyen/model/checkout/CardDetailsRequest.java index b382e1899..537bd8f05 100644 --- a/src/main/java/com/adyen/model/checkout/CardDetailsRequest.java +++ b/src/main/java/com/adyen/model/checkout/CardDetailsRequest.java @@ -77,6 +77,11 @@ public String getCardNumber() { } + /** + * A minimum of the first 8 digits of the card number and a maximum of the full card number. 11 digits gives the best result. You must be [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide) to collect raw card data. + * + * @param cardNumber + */ @JsonProperty(JSON_PROPERTY_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardNumber(String cardNumber) { @@ -102,6 +107,11 @@ public String getCountryCode() { } + /** + * The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -127,6 +137,11 @@ public String getEncryptedCardNumber() { } + /** + * The encrypted card number. + * + * @param encryptedCardNumber + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptedCardNumber(String encryptedCardNumber) { @@ -152,6 +167,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -185,6 +205,11 @@ public List getSupportedBrands() { } + /** + * The card brands you support. This is the [`brands`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods__resParam_paymentMethods-brands) array from your [`/paymentMethods`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/paymentMethods) response. If not included, our API uses the ones configured for your merchant account and, if provided, the country code. + * + * @param supportedBrands + */ @JsonProperty(JSON_PROPERTY_SUPPORTED_BRANDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportedBrands(List supportedBrands) { diff --git a/src/main/java/com/adyen/model/checkout/CardDetailsResponse.java b/src/main/java/com/adyen/model/checkout/CardDetailsResponse.java index 0a13ee6a9..14cf6a064 100644 --- a/src/main/java/com/adyen/model/checkout/CardDetailsResponse.java +++ b/src/main/java/com/adyen/model/checkout/CardDetailsResponse.java @@ -70,6 +70,11 @@ public List getBrands() { } + /** + * The list of brands identified for the card. + * + * @param brands + */ @JsonProperty(JSON_PROPERTY_BRANDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrands(List brands) { diff --git a/src/main/java/com/adyen/model/checkout/CardDonations.java b/src/main/java/com/adyen/model/checkout/CardDonations.java new file mode 100644 index 000000000..12c747b55 --- /dev/null +++ b/src/main/java/com/adyen/model/checkout/CardDonations.java @@ -0,0 +1,863 @@ +/* + * Adyen Checkout API + * + * The version of the OpenAPI document: 71 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.checkout; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * CardDonations + */ +@JsonPropertyOrder({ + CardDonations.JSON_PROPERTY_BRAND, + CardDonations.JSON_PROPERTY_CHECKOUT_ATTEMPT_ID, + CardDonations.JSON_PROPERTY_CUPSECUREPLUS_SMSCODE, + CardDonations.JSON_PROPERTY_CVC, + CardDonations.JSON_PROPERTY_ENCRYPTED_CARD_NUMBER, + CardDonations.JSON_PROPERTY_ENCRYPTED_EXPIRY_MONTH, + CardDonations.JSON_PROPERTY_ENCRYPTED_EXPIRY_YEAR, + CardDonations.JSON_PROPERTY_ENCRYPTED_SECURITY_CODE, + CardDonations.JSON_PROPERTY_EXPIRY_MONTH, + CardDonations.JSON_PROPERTY_EXPIRY_YEAR, + CardDonations.JSON_PROPERTY_FUNDING_SOURCE, + CardDonations.JSON_PROPERTY_HOLDER_NAME, + CardDonations.JSON_PROPERTY_NETWORK_PAYMENT_REFERENCE, + CardDonations.JSON_PROPERTY_NUMBER, + CardDonations.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE, + CardDonations.JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE, + CardDonations.JSON_PROPERTY_STORED_PAYMENT_METHOD_ID, + CardDonations.JSON_PROPERTY_THREE_D_S2_SDK_VERSION, + CardDonations.JSON_PROPERTY_TYPE +}) + +public class CardDonations { + public static final String JSON_PROPERTY_BRAND = "brand"; + private String brand; + + public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID = "checkoutAttemptId"; + private String checkoutAttemptId; + + public static final String JSON_PROPERTY_CUPSECUREPLUS_SMSCODE = "cupsecureplus.smscode"; + private String cupsecureplusSmscode; + + public static final String JSON_PROPERTY_CVC = "cvc"; + private String cvc; + + public static final String JSON_PROPERTY_ENCRYPTED_CARD_NUMBER = "encryptedCardNumber"; + private String encryptedCardNumber; + + public static final String JSON_PROPERTY_ENCRYPTED_EXPIRY_MONTH = "encryptedExpiryMonth"; + private String encryptedExpiryMonth; + + public static final String JSON_PROPERTY_ENCRYPTED_EXPIRY_YEAR = "encryptedExpiryYear"; + private String encryptedExpiryYear; + + public static final String JSON_PROPERTY_ENCRYPTED_SECURITY_CODE = "encryptedSecurityCode"; + private String encryptedSecurityCode; + + public static final String JSON_PROPERTY_EXPIRY_MONTH = "expiryMonth"; + private String expiryMonth; + + public static final String JSON_PROPERTY_EXPIRY_YEAR = "expiryYear"; + private String expiryYear; + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + */ + public enum FundingSourceEnum { + CREDIT("credit"), + + DEBIT("debit"); + + private String value; + + FundingSourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FundingSourceEnum fromValue(String value) { + for (FundingSourceEnum b : FundingSourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FUNDING_SOURCE = "fundingSource"; + private FundingSourceEnum fundingSource; + + public static final String JSON_PROPERTY_HOLDER_NAME = "holderName"; + private String holderName; + + public static final String JSON_PROPERTY_NETWORK_PAYMENT_REFERENCE = "networkPaymentReference"; + private String networkPaymentReference; + + public static final String JSON_PROPERTY_NUMBER = "number"; + private String number; + + public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE = "recurringDetailReference"; + private String recurringDetailReference; + + public static final String JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE = "shopperNotificationReference"; + private String shopperNotificationReference; + + public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID = "storedPaymentMethodId"; + private String storedPaymentMethodId; + + public static final String JSON_PROPERTY_THREE_D_S2_SDK_VERSION = "threeDS2SdkVersion"; + private String threeDS2SdkVersion; + + /** + * Default payment method details. Common for scheme payment methods, and for simple payment method details. + */ + public enum TypeEnum { + BCMC("bcmc"), + + SCHEME("scheme"), + + NETWORKTOKEN("networkToken"), + + GIFTCARD("giftcard"), + + CARD("card"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TypeEnum fromValue(String value) { + for (TypeEnum b : TypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TYPE = "type"; + private TypeEnum type = TypeEnum.SCHEME; + + public CardDonations() { + } + + public CardDonations brand(String brand) { + this.brand = brand; + return this; + } + + /** + * Secondary brand of the card. For example: **plastix**, **hmclub**. + * @return brand + **/ + @ApiModelProperty(value = "Secondary brand of the card. For example: **plastix**, **hmclub**.") + @JsonProperty(JSON_PROPERTY_BRAND) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getBrand() { + return brand; + } + + + /** + * Secondary brand of the card. For example: **plastix**, **hmclub**. + * + * @param brand + */ + @JsonProperty(JSON_PROPERTY_BRAND) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBrand(String brand) { + this.brand = brand; + } + + + public CardDonations checkoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + return this; + } + + /** + * The checkout attempt identifier. + * @return checkoutAttemptId + **/ + @ApiModelProperty(value = "The checkout attempt identifier.") + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCheckoutAttemptId() { + return checkoutAttemptId; + } + + + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCheckoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + } + + + public CardDonations cupsecureplusSmscode(String cupsecureplusSmscode) { + this.cupsecureplusSmscode = cupsecureplusSmscode; + return this; + } + + /** + * Get cupsecureplusSmscode + * @return cupsecureplusSmscode + * @deprecated + **/ + @Deprecated + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_CUPSECUREPLUS_SMSCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCupsecureplusSmscode() { + return cupsecureplusSmscode; + } + + + /** + * cupsecureplusSmscode + * + * @param cupsecureplusSmscode + */ + @Deprecated + @JsonProperty(JSON_PROPERTY_CUPSECUREPLUS_SMSCODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCupsecureplusSmscode(String cupsecureplusSmscode) { + this.cupsecureplusSmscode = cupsecureplusSmscode; + } + + + public CardDonations cvc(String cvc) { + this.cvc = cvc; + return this; + } + + /** + * The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * @return cvc + **/ + @ApiModelProperty(value = "The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).") + @JsonProperty(JSON_PROPERTY_CVC) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCvc() { + return cvc; + } + + + /** + * The card verification code. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param cvc + */ + @JsonProperty(JSON_PROPERTY_CVC) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCvc(String cvc) { + this.cvc = cvc; + } + + + public CardDonations encryptedCardNumber(String encryptedCardNumber) { + this.encryptedCardNumber = encryptedCardNumber; + return this; + } + + /** + * The encrypted card number. + * @return encryptedCardNumber + **/ + @ApiModelProperty(value = "The encrypted card number.") + @JsonProperty(JSON_PROPERTY_ENCRYPTED_CARD_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEncryptedCardNumber() { + return encryptedCardNumber; + } + + + /** + * The encrypted card number. + * + * @param encryptedCardNumber + */ + @JsonProperty(JSON_PROPERTY_ENCRYPTED_CARD_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEncryptedCardNumber(String encryptedCardNumber) { + this.encryptedCardNumber = encryptedCardNumber; + } + + + public CardDonations encryptedExpiryMonth(String encryptedExpiryMonth) { + this.encryptedExpiryMonth = encryptedExpiryMonth; + return this; + } + + /** + * The encrypted card expiry month. + * @return encryptedExpiryMonth + **/ + @ApiModelProperty(value = "The encrypted card expiry month.") + @JsonProperty(JSON_PROPERTY_ENCRYPTED_EXPIRY_MONTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEncryptedExpiryMonth() { + return encryptedExpiryMonth; + } + + + /** + * The encrypted card expiry month. + * + * @param encryptedExpiryMonth + */ + @JsonProperty(JSON_PROPERTY_ENCRYPTED_EXPIRY_MONTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEncryptedExpiryMonth(String encryptedExpiryMonth) { + this.encryptedExpiryMonth = encryptedExpiryMonth; + } + + + public CardDonations encryptedExpiryYear(String encryptedExpiryYear) { + this.encryptedExpiryYear = encryptedExpiryYear; + return this; + } + + /** + * The encrypted card expiry year. + * @return encryptedExpiryYear + **/ + @ApiModelProperty(value = "The encrypted card expiry year.") + @JsonProperty(JSON_PROPERTY_ENCRYPTED_EXPIRY_YEAR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEncryptedExpiryYear() { + return encryptedExpiryYear; + } + + + /** + * The encrypted card expiry year. + * + * @param encryptedExpiryYear + */ + @JsonProperty(JSON_PROPERTY_ENCRYPTED_EXPIRY_YEAR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEncryptedExpiryYear(String encryptedExpiryYear) { + this.encryptedExpiryYear = encryptedExpiryYear; + } + + + public CardDonations encryptedSecurityCode(String encryptedSecurityCode) { + this.encryptedSecurityCode = encryptedSecurityCode; + return this; + } + + /** + * The encrypted card verification code. + * @return encryptedSecurityCode + **/ + @ApiModelProperty(value = "The encrypted card verification code.") + @JsonProperty(JSON_PROPERTY_ENCRYPTED_SECURITY_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getEncryptedSecurityCode() { + return encryptedSecurityCode; + } + + + /** + * The encrypted card verification code. + * + * @param encryptedSecurityCode + */ + @JsonProperty(JSON_PROPERTY_ENCRYPTED_SECURITY_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEncryptedSecurityCode(String encryptedSecurityCode) { + this.encryptedSecurityCode = encryptedSecurityCode; + } + + + public CardDonations expiryMonth(String expiryMonth) { + this.expiryMonth = expiryMonth; + return this; + } + + /** + * The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * @return expiryMonth + **/ + @ApiModelProperty(value = "The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).") + @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getExpiryMonth() { + return expiryMonth; + } + + + /** + * The card expiry month. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param expiryMonth + */ + @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiryMonth(String expiryMonth) { + this.expiryMonth = expiryMonth; + } + + + public CardDonations expiryYear(String expiryYear) { + this.expiryYear = expiryYear; + return this; + } + + /** + * The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * @return expiryYear + **/ + @ApiModelProperty(value = "The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).") + @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getExpiryYear() { + return expiryYear; + } + + + /** + * The card expiry year. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param expiryYear + */ + @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setExpiryYear(String expiryYear) { + this.expiryYear = expiryYear; + } + + + public CardDonations fundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + return this; + } + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * @return fundingSource + **/ + @ApiModelProperty(value = "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.") + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FundingSourceEnum getFundingSource() { + return fundingSource; + } + + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + } + + + public CardDonations holderName(String holderName) { + this.holderName = holderName; + return this; + } + + /** + * The name of the card holder. + * @return holderName + **/ + @ApiModelProperty(value = "The name of the card holder.") + @JsonProperty(JSON_PROPERTY_HOLDER_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getHolderName() { + return holderName; + } + + + /** + * The name of the card holder. + * + * @param holderName + */ + @JsonProperty(JSON_PROPERTY_HOLDER_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHolderName(String holderName) { + this.holderName = holderName; + } + + + public CardDonations networkPaymentReference(String networkPaymentReference) { + this.networkPaymentReference = networkPaymentReference; + return this; + } + + /** + * The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. + * @return networkPaymentReference + **/ + @ApiModelProperty(value = "The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment.") + @JsonProperty(JSON_PROPERTY_NETWORK_PAYMENT_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getNetworkPaymentReference() { + return networkPaymentReference; + } + + + /** + * The network token reference. This is the [`networkTxReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_additionalData-ResponseAdditionalDataCommon-networkTxReference) from the response to the first payment. + * + * @param networkPaymentReference + */ + @JsonProperty(JSON_PROPERTY_NETWORK_PAYMENT_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setNetworkPaymentReference(String networkPaymentReference) { + this.networkPaymentReference = networkPaymentReference; + } + + + public CardDonations number(String number) { + this.number = number; + return this; + } + + /** + * The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * @return number + **/ + @ApiModelProperty(value = "The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).") + @JsonProperty(JSON_PROPERTY_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getNumber() { + return number; + } + + + /** + * The card number. Only collect raw card data if you are [fully PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide). + * + * @param number + */ + @JsonProperty(JSON_PROPERTY_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setNumber(String number) { + this.number = number; + } + + + public CardDonations recurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return recurringDetailReference + * @deprecated + **/ + @Deprecated + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getRecurringDetailReference() { + return recurringDetailReference; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ + @Deprecated + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setRecurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + } + + + public CardDonations shopperNotificationReference(String shopperNotificationReference) { + this.shopperNotificationReference = shopperNotificationReference; + return this; + } + + /** + * The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. + * @return shopperNotificationReference + **/ + @ApiModelProperty(value = "The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India.") + @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getShopperNotificationReference() { + return shopperNotificationReference; + } + + + /** + * The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used only for recurring payments in India. + * + * @param shopperNotificationReference + */ + @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setShopperNotificationReference(String shopperNotificationReference) { + this.shopperNotificationReference = shopperNotificationReference; + } + + + public CardDonations storedPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return storedPaymentMethodId + **/ + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStoredPaymentMethodId() { + return storedPaymentMethodId; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setStoredPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + } + + + public CardDonations threeDS2SdkVersion(String threeDS2SdkVersion) { + this.threeDS2SdkVersion = threeDS2SdkVersion; + return this; + } + + /** + * Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. + * @return threeDS2SdkVersion + **/ + @ApiModelProperty(value = "Required for mobile integrations. Version of the 3D Secure 2 mobile SDK.") + @JsonProperty(JSON_PROPERTY_THREE_D_S2_SDK_VERSION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getThreeDS2SdkVersion() { + return threeDS2SdkVersion; + } + + + /** + * Required for mobile integrations. Version of the 3D Secure 2 mobile SDK. + * + * @param threeDS2SdkVersion + */ + @JsonProperty(JSON_PROPERTY_THREE_D_S2_SDK_VERSION) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setThreeDS2SdkVersion(String threeDS2SdkVersion) { + this.threeDS2SdkVersion = threeDS2SdkVersion; + } + + + public CardDonations type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * Default payment method details. Common for scheme payment methods, and for simple payment method details. + * @return type + **/ + @ApiModelProperty(value = "Default payment method details. Common for scheme payment methods, and for simple payment method details.") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TypeEnum getType() { + return type; + } + + + /** + * Default payment method details. Common for scheme payment methods, and for simple payment method details. + * + * @param type + */ + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(TypeEnum type) { + this.type = type; + } + + + /** + * Return true if this CardDonations object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + CardDonations cardDonations = (CardDonations) o; + return Objects.equals(this.brand, cardDonations.brand) && + Objects.equals(this.checkoutAttemptId, cardDonations.checkoutAttemptId) && + Objects.equals(this.cupsecureplusSmscode, cardDonations.cupsecureplusSmscode) && + Objects.equals(this.cvc, cardDonations.cvc) && + Objects.equals(this.encryptedCardNumber, cardDonations.encryptedCardNumber) && + Objects.equals(this.encryptedExpiryMonth, cardDonations.encryptedExpiryMonth) && + Objects.equals(this.encryptedExpiryYear, cardDonations.encryptedExpiryYear) && + Objects.equals(this.encryptedSecurityCode, cardDonations.encryptedSecurityCode) && + Objects.equals(this.expiryMonth, cardDonations.expiryMonth) && + Objects.equals(this.expiryYear, cardDonations.expiryYear) && + Objects.equals(this.fundingSource, cardDonations.fundingSource) && + Objects.equals(this.holderName, cardDonations.holderName) && + Objects.equals(this.networkPaymentReference, cardDonations.networkPaymentReference) && + Objects.equals(this.number, cardDonations.number) && + Objects.equals(this.recurringDetailReference, cardDonations.recurringDetailReference) && + Objects.equals(this.shopperNotificationReference, cardDonations.shopperNotificationReference) && + Objects.equals(this.storedPaymentMethodId, cardDonations.storedPaymentMethodId) && + Objects.equals(this.threeDS2SdkVersion, cardDonations.threeDS2SdkVersion) && + Objects.equals(this.type, cardDonations.type); + } + + @Override + public int hashCode() { + return Objects.hash(brand, checkoutAttemptId, cupsecureplusSmscode, cvc, encryptedCardNumber, encryptedExpiryMonth, encryptedExpiryYear, encryptedSecurityCode, expiryMonth, expiryYear, fundingSource, holderName, networkPaymentReference, number, recurringDetailReference, shopperNotificationReference, storedPaymentMethodId, threeDS2SdkVersion, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class CardDonations {\n"); + sb.append(" brand: ").append(toIndentedString(brand)).append("\n"); + sb.append(" checkoutAttemptId: ").append(toIndentedString(checkoutAttemptId)).append("\n"); + sb.append(" cupsecureplusSmscode: ").append(toIndentedString(cupsecureplusSmscode)).append("\n"); + sb.append(" cvc: ").append(toIndentedString(cvc)).append("\n"); + sb.append(" encryptedCardNumber: ").append(toIndentedString(encryptedCardNumber)).append("\n"); + sb.append(" encryptedExpiryMonth: ").append(toIndentedString(encryptedExpiryMonth)).append("\n"); + sb.append(" encryptedExpiryYear: ").append(toIndentedString(encryptedExpiryYear)).append("\n"); + sb.append(" encryptedSecurityCode: ").append(toIndentedString(encryptedSecurityCode)).append("\n"); + sb.append(" expiryMonth: ").append(toIndentedString(expiryMonth)).append("\n"); + sb.append(" expiryYear: ").append(toIndentedString(expiryYear)).append("\n"); + sb.append(" fundingSource: ").append(toIndentedString(fundingSource)).append("\n"); + sb.append(" holderName: ").append(toIndentedString(holderName)).append("\n"); + sb.append(" networkPaymentReference: ").append(toIndentedString(networkPaymentReference)).append("\n"); + sb.append(" number: ").append(toIndentedString(number)).append("\n"); + sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n"); + sb.append(" shopperNotificationReference: ").append(toIndentedString(shopperNotificationReference)).append("\n"); + sb.append(" storedPaymentMethodId: ").append(toIndentedString(storedPaymentMethodId)).append("\n"); + sb.append(" threeDS2SdkVersion: ").append(toIndentedString(threeDS2SdkVersion)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of CardDonations given an JSON string + * + * @param jsonString JSON string + * @return An instance of CardDonations + * @throws JsonProcessingException if the JSON string is invalid with respect to CardDonations + */ + public static CardDonations fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, CardDonations.class); + } +/** + * Convert an instance of CardDonations to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/checkout/CellulantDetails.java b/src/main/java/com/adyen/model/checkout/CellulantDetails.java index 9d4a564d3..92c5f4fd6 100644 --- a/src/main/java/com/adyen/model/checkout/CellulantDetails.java +++ b/src/main/java/com/adyen/model/checkout/CellulantDetails.java @@ -100,6 +100,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -125,6 +130,11 @@ public String getIssuer() { } + /** + * The Cellulant issuer. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **Cellulant** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutAwaitAction.java b/src/main/java/com/adyen/model/checkout/CheckoutAwaitAction.java index 55df5424d..a49e748aa 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutAwaitAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutAwaitAction.java @@ -104,6 +104,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -129,6 +134,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -154,6 +164,11 @@ public TypeEnum getType() { } + /** + * **await** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -179,6 +194,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutDelegatedAuthenticationAction.java b/src/main/java/com/adyen/model/checkout/CheckoutDelegatedAuthenticationAction.java index a9f37c828..43fcbdc85 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutDelegatedAuthenticationAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutDelegatedAuthenticationAction.java @@ -112,6 +112,11 @@ public String getAuthorisationToken() { } + /** + * A token needed to authorise a payment. + * + * @param authorisationToken + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationToken(String authorisationToken) { @@ -137,6 +142,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -162,6 +172,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -187,6 +202,11 @@ public String getToken() { } + /** + * A token to pass to the delegatedAuthentication component. + * + * @param token + */ @JsonProperty(JSON_PROPERTY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToken(String token) { @@ -212,6 +232,11 @@ public TypeEnum getType() { } + /** + * **delegatedAuthentication** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -237,6 +262,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutNativeRedirectAction.java b/src/main/java/com/adyen/model/checkout/CheckoutNativeRedirectAction.java index 1c3fba0f0..90a92e5f6 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutNativeRedirectAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutNativeRedirectAction.java @@ -123,6 +123,11 @@ public Map getData() { } + /** + * When the redirect URL must be accessed via POST, use this data to post to the redirect URL. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(Map data) { @@ -148,6 +153,11 @@ public String getMethod() { } + /** + * Specifies the HTTP method, for example GET or POST. + * + * @param method + */ @JsonProperty(JSON_PROPERTY_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMethod(String method) { @@ -173,6 +183,11 @@ public String getNativeRedirectData() { } + /** + * Native SDK's redirect data containing the direct issuer link and state data that must be submitted to the /v1/nativeRedirect/redirectResult. + * + * @param nativeRedirectData + */ @JsonProperty(JSON_PROPERTY_NATIVE_REDIRECT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNativeRedirectData(String nativeRedirectData) { @@ -198,6 +213,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -223,6 +243,11 @@ public TypeEnum getType() { } + /** + * **nativeRedirect** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -248,6 +273,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutOrderResponse.java b/src/main/java/com/adyen/model/checkout/CheckoutOrderResponse.java index 72d458f34..bba012e47 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutOrderResponse.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutOrderResponse.java @@ -80,6 +80,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -105,6 +110,11 @@ public String getExpiresAt() { } + /** + * The expiry date for the order. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(String expiresAt) { @@ -130,6 +140,11 @@ public String getOrderData() { } + /** + * The encrypted order data. + * + * @param orderData + */ @JsonProperty(JSON_PROPERTY_ORDER_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderData(String orderData) { @@ -155,6 +170,11 @@ public String getPspReference() { } + /** + * The `pspReference` that belongs to the order. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -180,6 +200,11 @@ public String getReference() { } + /** + * The merchant reference for the order. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -205,6 +230,11 @@ public Amount getRemainingAmount() { } + /** + * remainingAmount + * + * @param remainingAmount + */ @JsonProperty(JSON_PROPERTY_REMAINING_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemainingAmount(Amount remainingAmount) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutQrCodeAction.java b/src/main/java/com/adyen/model/checkout/CheckoutQrCodeAction.java index 3f16ae65b..e48a8977a 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutQrCodeAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutQrCodeAction.java @@ -112,6 +112,11 @@ public String getExpiresAt() { } + /** + * Expiry time of the QR code. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(String expiresAt) { @@ -137,6 +142,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -162,6 +172,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -187,6 +202,11 @@ public String getQrCodeData() { } + /** + * The contents of the QR code as a UTF8 string. + * + * @param qrCodeData + */ @JsonProperty(JSON_PROPERTY_QR_CODE_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQrCodeData(String qrCodeData) { @@ -212,6 +232,11 @@ public TypeEnum getType() { } + /** + * **qrCode** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -237,6 +262,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutRedirectAction.java b/src/main/java/com/adyen/model/checkout/CheckoutRedirectAction.java index 508c6c403..6f3038a84 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutRedirectAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutRedirectAction.java @@ -119,6 +119,11 @@ public Map getData() { } + /** + * When the redirect URL must be accessed via POST, use this data to post to the redirect URL. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(Map data) { @@ -144,6 +149,11 @@ public String getMethod() { } + /** + * Specifies the HTTP method, for example GET or POST. + * + * @param method + */ @JsonProperty(JSON_PROPERTY_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMethod(String method) { @@ -169,6 +179,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -194,6 +209,11 @@ public TypeEnum getType() { } + /** + * **redirect** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -219,6 +239,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutSDKAction.java b/src/main/java/com/adyen/model/checkout/CheckoutSDKAction.java index 67db1f781..f8fa4d742 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutSDKAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutSDKAction.java @@ -113,6 +113,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -138,6 +143,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -171,6 +181,11 @@ public Map getSdkData() { } + /** + * The data to pass to the SDK. + * + * @param sdkData + */ @JsonProperty(JSON_PROPERTY_SDK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkData(Map sdkData) { @@ -196,6 +211,11 @@ public TypeEnum getType() { } + /** + * The type of the action. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -221,6 +241,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutSessionInstallmentOption.java b/src/main/java/com/adyen/model/checkout/CheckoutSessionInstallmentOption.java index 1a51f29e1..74d5dc3c6 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutSessionInstallmentOption.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutSessionInstallmentOption.java @@ -112,6 +112,11 @@ public List getPlans() { } + /** + * Defines the type of installment plan. If not set, defaults to **regular**. Possible values: * **regular** * **revolving** + * + * @param plans + */ @JsonProperty(JSON_PROPERTY_PLANS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlans(List plans) { @@ -137,6 +142,11 @@ public Integer getPreselectedValue() { } + /** + * Preselected number of installments offered for this payment method. + * + * @param preselectedValue + */ @JsonProperty(JSON_PROPERTY_PRESELECTED_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreselectedValue(Integer preselectedValue) { @@ -170,6 +180,11 @@ public List getValues() { } + /** + * An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`. + * + * @param values + */ @JsonProperty(JSON_PROPERTY_VALUES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValues(List values) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutThreeDS2Action.java b/src/main/java/com/adyen/model/checkout/CheckoutThreeDS2Action.java index 0af504674..161dbbb92 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutThreeDS2Action.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutThreeDS2Action.java @@ -116,6 +116,11 @@ public String getAuthorisationToken() { } + /** + * A token needed to authorise a payment. + * + * @param authorisationToken + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationToken(String authorisationToken) { @@ -141,6 +146,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -166,6 +176,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -191,6 +206,11 @@ public String getSubtype() { } + /** + * A subtype of the token. + * + * @param subtype + */ @JsonProperty(JSON_PROPERTY_SUBTYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubtype(String subtype) { @@ -216,6 +236,11 @@ public String getToken() { } + /** + * A token to pass to the 3DS2 Component to get the fingerprint. + * + * @param token + */ @JsonProperty(JSON_PROPERTY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToken(String token) { @@ -241,6 +266,11 @@ public TypeEnum getType() { } + /** + * **threeDS2** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -266,6 +296,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CheckoutVoucherAction.java b/src/main/java/com/adyen/model/checkout/CheckoutVoucherAction.java index 0047a7ca5..9af9cacff 100644 --- a/src/main/java/com/adyen/model/checkout/CheckoutVoucherAction.java +++ b/src/main/java/com/adyen/model/checkout/CheckoutVoucherAction.java @@ -173,6 +173,11 @@ public String getAlternativeReference() { } + /** + * The voucher alternative reference code. + * + * @param alternativeReference + */ @JsonProperty(JSON_PROPERTY_ALTERNATIVE_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlternativeReference(String alternativeReference) { @@ -198,6 +203,11 @@ public String getCollectionInstitutionNumber() { } + /** + * A collection institution number (store number) for Econtext Pay-Easy ATM. + * + * @param collectionInstitutionNumber + */ @JsonProperty(JSON_PROPERTY_COLLECTION_INSTITUTION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCollectionInstitutionNumber(String collectionInstitutionNumber) { @@ -223,6 +233,11 @@ public String getDownloadUrl() { } + /** + * The URL to download the voucher. + * + * @param downloadUrl + */ @JsonProperty(JSON_PROPERTY_DOWNLOAD_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDownloadUrl(String downloadUrl) { @@ -248,6 +263,11 @@ public String getEntity() { } + /** + * An entity number of Multibanco. + * + * @param entity + */ @JsonProperty(JSON_PROPERTY_ENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntity(String entity) { @@ -273,6 +293,11 @@ public String getExpiresAt() { } + /** + * The date time of the voucher expiry. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(String expiresAt) { @@ -298,6 +323,11 @@ public Amount getInitialAmount() { } + /** + * initialAmount + * + * @param initialAmount + */ @JsonProperty(JSON_PROPERTY_INITIAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInitialAmount(Amount initialAmount) { @@ -323,6 +353,11 @@ public String getInstructionsUrl() { } + /** + * The URL to the detailed instructions to make payment using the voucher. + * + * @param instructionsUrl + */ @JsonProperty(JSON_PROPERTY_INSTRUCTIONS_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstructionsUrl(String instructionsUrl) { @@ -348,6 +383,11 @@ public String getIssuer() { } + /** + * The issuer of the voucher. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -373,6 +413,11 @@ public String getMaskedTelephoneNumber() { } + /** + * The shopper telephone number (partially masked). + * + * @param maskedTelephoneNumber + */ @JsonProperty(JSON_PROPERTY_MASKED_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaskedTelephoneNumber(String maskedTelephoneNumber) { @@ -398,6 +443,11 @@ public String getMerchantName() { } + /** + * The merchant name. + * + * @param merchantName + */ @JsonProperty(JSON_PROPERTY_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantName(String merchantName) { @@ -423,6 +473,11 @@ public String getMerchantReference() { } + /** + * The merchant reference. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -448,6 +503,11 @@ public String getPassCreationToken() { } + /** + * A base64 encoded signature of all properties + * + * @param passCreationToken + */ @JsonProperty(JSON_PROPERTY_PASS_CREATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassCreationToken(String passCreationToken) { @@ -473,6 +533,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -498,6 +563,11 @@ public String getPaymentMethodType() { } + /** + * Specifies the payment method. + * + * @param paymentMethodType + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodType(String paymentMethodType) { @@ -523,6 +593,11 @@ public String getReference() { } + /** + * The voucher reference code. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -548,6 +623,11 @@ public String getShopperEmail() { } + /** + * The shopper email. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -573,6 +653,11 @@ public String getShopperName() { } + /** + * The shopper name. + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(String shopperName) { @@ -598,6 +683,11 @@ public Amount getSurcharge() { } + /** + * surcharge + * + * @param surcharge + */ @JsonProperty(JSON_PROPERTY_SURCHARGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSurcharge(Amount surcharge) { @@ -623,6 +713,11 @@ public Amount getTotalAmount() { } + /** + * totalAmount + * + * @param totalAmount + */ @JsonProperty(JSON_PROPERTY_TOTAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalAmount(Amount totalAmount) { @@ -648,6 +743,11 @@ public TypeEnum getType() { } + /** + * **voucher** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -673,6 +773,11 @@ public String getUrl() { } + /** + * Specifies the URL to redirect to. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/CommonField.java b/src/main/java/com/adyen/model/checkout/CommonField.java index 35c235948..7e7cd23db 100644 --- a/src/main/java/com/adyen/model/checkout/CommonField.java +++ b/src/main/java/com/adyen/model/checkout/CommonField.java @@ -63,6 +63,11 @@ public String getName() { } + /** + * Name of the field. For example, Name of External Platform. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -88,6 +93,11 @@ public String getVersion() { } + /** + * Version of the field. For example, Version of External Platform. + * + * @param version + */ @JsonProperty(JSON_PROPERTY_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersion(String version) { diff --git a/src/main/java/com/adyen/model/checkout/Company.java b/src/main/java/com/adyen/model/checkout/Company.java index 9a5eb1e64..dcadf1b11 100644 --- a/src/main/java/com/adyen/model/checkout/Company.java +++ b/src/main/java/com/adyen/model/checkout/Company.java @@ -79,6 +79,11 @@ public String getHomepage() { } + /** + * The company website's home page. + * + * @param homepage + */ @JsonProperty(JSON_PROPERTY_HOMEPAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHomepage(String homepage) { @@ -104,6 +109,11 @@ public String getName() { } + /** + * The company name. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -129,6 +139,11 @@ public String getRegistrationNumber() { } + /** + * Registration number of the company. + * + * @param registrationNumber + */ @JsonProperty(JSON_PROPERTY_REGISTRATION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegistrationNumber(String registrationNumber) { @@ -154,6 +169,11 @@ public String getRegistryLocation() { } + /** + * Registry location of the company. + * + * @param registryLocation + */ @JsonProperty(JSON_PROPERTY_REGISTRY_LOCATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegistryLocation(String registryLocation) { @@ -179,6 +199,11 @@ public String getTaxId() { } + /** + * Tax ID of the company. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { @@ -204,6 +229,11 @@ public String getType() { } + /** + * The company type. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionRequest.java b/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionRequest.java index f2e962912..b78e07496 100644 --- a/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionRequest.java +++ b/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionRequest.java @@ -102,6 +102,7 @@ CreateCheckoutSessionRequest.JSON_PROPERTY_SHOPPER_REFERENCE, CreateCheckoutSessionRequest.JSON_PROPERTY_SHOPPER_STATEMENT, CreateCheckoutSessionRequest.JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT, + CreateCheckoutSessionRequest.JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON, CreateCheckoutSessionRequest.JSON_PROPERTY_SOCIAL_SECURITY_NUMBER, CreateCheckoutSessionRequest.JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES, CreateCheckoutSessionRequest.JSON_PROPERTY_SPLITS, @@ -407,6 +408,9 @@ public static ShopperInteractionEnum fromValue(String value) { public static final String JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT = "showInstallmentAmount"; private Boolean showInstallmentAmount; + public static final String JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON = "showRemovePaymentMethodButton"; + private Boolean showRemovePaymentMethodButton; + public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER = "socialSecurityNumber"; private String socialSecurityNumber; @@ -495,6 +499,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -520,6 +529,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -553,6 +567,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -586,6 +605,11 @@ public List getAllowedPaymentMethods() { } + /** + * List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param allowedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_ALLOWED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedPaymentMethods(List allowedPaymentMethods) { @@ -611,6 +635,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -636,6 +665,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -661,6 +695,11 @@ public AuthenticationData getAuthenticationData() { } + /** + * authenticationData + * + * @param authenticationData + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationData(AuthenticationData authenticationData) { @@ -686,6 +725,11 @@ public BillingAddress getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(BillingAddress billingAddress) { @@ -719,6 +763,11 @@ public List getBlockedPaymentMethods() { } + /** + * List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param blockedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_BLOCKED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlockedPaymentMethods(List blockedPaymentMethods) { @@ -744,6 +793,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -769,6 +823,11 @@ public ChannelEnum getChannel() { } + /** + * The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * **iOS** * **Android** * **Web** + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(ChannelEnum channel) { @@ -794,6 +853,11 @@ public Company getCompany() { } + /** + * company + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(Company company) { @@ -819,6 +883,11 @@ public String getCountryCode() { } + /** + * The shopper's two-letter country code. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -844,6 +913,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -869,6 +943,11 @@ public OffsetDateTime getDeliverAt() { } + /** + * The date and time when the purchased goods should be delivered. [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**. + * + * @param deliverAt + */ @JsonProperty(JSON_PROPERTY_DELIVER_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliverAt(OffsetDateTime deliverAt) { @@ -894,6 +973,11 @@ public DeliveryAddress getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(DeliveryAddress deliveryAddress) { @@ -919,6 +1003,11 @@ public Boolean getEnableOneClick() { } + /** + * When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments. + * + * @param enableOneClick + */ @JsonProperty(JSON_PROPERTY_ENABLE_ONE_CLICK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableOneClick(Boolean enableOneClick) { @@ -944,6 +1033,11 @@ public Boolean getEnablePayOut() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for payouts. + * + * @param enablePayOut + */ @JsonProperty(JSON_PROPERTY_ENABLE_PAY_OUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnablePayOut(Boolean enablePayOut) { @@ -969,6 +1063,11 @@ public Boolean getEnableRecurring() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. + * + * @param enableRecurring + */ @JsonProperty(JSON_PROPERTY_ENABLE_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableRecurring(Boolean enableRecurring) { @@ -994,6 +1093,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { @@ -1019,6 +1123,11 @@ public FundOrigin getFundOrigin() { } + /** + * fundOrigin + * + * @param fundOrigin + */ @JsonProperty(JSON_PROPERTY_FUND_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundOrigin(FundOrigin fundOrigin) { @@ -1044,6 +1153,11 @@ public FundRecipient getFundRecipient() { } + /** + * fundRecipient + * + * @param fundRecipient + */ @JsonProperty(JSON_PROPERTY_FUND_RECIPIENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundRecipient(FundRecipient fundRecipient) { @@ -1077,6 +1191,11 @@ public Map getInstallmentOptions() { } + /** + * A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options. + * + * @param installmentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentOptions(Map installmentOptions) { @@ -1110,6 +1229,11 @@ public List getLineItems() { } + /** + * Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -1135,6 +1259,11 @@ public Mandate getMandate() { } + /** + * mandate + * + * @param mandate + */ @JsonProperty(JSON_PROPERTY_MANDATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMandate(Mandate mandate) { @@ -1160,6 +1289,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -1185,6 +1319,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -1210,6 +1349,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -1243,6 +1387,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -1268,6 +1417,11 @@ public ModeEnum getMode() { } + /** + * Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration + * + * @param mode + */ @JsonProperty(JSON_PROPERTY_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMode(ModeEnum mode) { @@ -1293,6 +1447,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -1318,6 +1477,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -1343,6 +1507,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -1368,6 +1537,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -1393,6 +1567,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1418,6 +1597,11 @@ public String getRedirectFromIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting back from the issuer. + * + * @param redirectFromIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod) { @@ -1443,6 +1627,11 @@ public String getRedirectToIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting to the issuer. + * + * @param redirectToIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectToIssuerMethod(String redirectToIssuerMethod) { @@ -1468,6 +1657,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1493,6 +1687,11 @@ public String getReturnUrl() { } + /** + * The URL to return to when a redirect payment is completed. + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -1518,6 +1717,11 @@ public RiskData getRiskData() { } + /** + * riskData + * + * @param riskData + */ @JsonProperty(JSON_PROPERTY_RISK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskData(RiskData riskData) { @@ -1543,6 +1747,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1568,6 +1777,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1593,6 +1807,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1618,6 +1837,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1643,6 +1867,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1668,6 +1897,11 @@ public String getShopperReference() { } + /** + * Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1693,6 +1927,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1718,6 +1957,11 @@ public Boolean getShowInstallmentAmount() { } + /** + * Set to true to show the payment amount per installment. + * + * @param showInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShowInstallmentAmount(Boolean showInstallmentAmount) { @@ -1725,6 +1969,36 @@ public void setShowInstallmentAmount(Boolean showInstallmentAmount) { } + public CreateCheckoutSessionRequest showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) { + this.showRemovePaymentMethodButton = showRemovePaymentMethodButton; + return this; + } + + /** + * Set to **true** to show a button that lets the shopper remove a stored payment method. + * @return showRemovePaymentMethodButton + **/ + @ApiModelProperty(value = "Set to **true** to show a button that lets the shopper remove a stored payment method.") + @JsonProperty(JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getShowRemovePaymentMethodButton() { + return showRemovePaymentMethodButton; + } + + + /** + * Set to **true** to show a button that lets the shopper remove a stored payment method. + * + * @param showRemovePaymentMethodButton + */ + @JsonProperty(JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) { + this.showRemovePaymentMethodButton = showRemovePaymentMethodButton; + } + + public CreateCheckoutSessionRequest socialSecurityNumber(String socialSecurityNumber) { this.socialSecurityNumber = socialSecurityNumber; return this; @@ -1743,6 +2017,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1768,6 +2047,11 @@ public Boolean getSplitCardFundingSources() { } + /** + * Boolean value indicating whether the card payment method should be split into separate debit and credit options. + * + * @param splitCardFundingSources + */ @JsonProperty(JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitCardFundingSources(Boolean splitCardFundingSources) { @@ -1801,6 +2085,11 @@ public List getSplits() { } + /** + * An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1826,6 +2115,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1851,6 +2145,11 @@ public Boolean getStorePaymentMethod() { } + /** + * When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. + * + * @param storePaymentMethod + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethod(Boolean storePaymentMethod) { @@ -1876,6 +2175,11 @@ public StorePaymentMethodModeEnum getStorePaymentMethodMode() { } + /** + * Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. + * + * @param storePaymentMethodMode + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethodMode(StorePaymentMethodModeEnum storePaymentMethodMode) { @@ -1901,6 +2205,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1926,6 +2235,11 @@ public String getThemeId() { } + /** + * Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout). The value can be any of the **Theme ID** values from your Customer Area. + * + * @param themeId + */ @JsonProperty(JSON_PROPERTY_THEME_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThemeId(String themeId) { @@ -1953,6 +2267,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -1979,6 +2298,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { @@ -2046,6 +2370,7 @@ public boolean equals(Object o) { Objects.equals(this.shopperReference, createCheckoutSessionRequest.shopperReference) && Objects.equals(this.shopperStatement, createCheckoutSessionRequest.shopperStatement) && Objects.equals(this.showInstallmentAmount, createCheckoutSessionRequest.showInstallmentAmount) && + Objects.equals(this.showRemovePaymentMethodButton, createCheckoutSessionRequest.showRemovePaymentMethodButton) && Objects.equals(this.socialSecurityNumber, createCheckoutSessionRequest.socialSecurityNumber) && Objects.equals(this.splitCardFundingSources, createCheckoutSessionRequest.splitCardFundingSources) && Objects.equals(this.splits, createCheckoutSessionRequest.splits) && @@ -2060,7 +2385,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(accountInfo, additionalAmount, additionalData, allowedPaymentMethods, amount, applicationInfo, authenticationData, billingAddress, blockedPaymentMethods, captureDelayHours, channel, company, countryCode, dateOfBirth, deliverAt, deliveryAddress, enableOneClick, enablePayOut, enableRecurring, expiresAt, fundOrigin, fundRecipient, installmentOptions, lineItems, mandate, mcc, merchantAccount, merchantOrderReference, metadata, mode, mpiData, platformChargebackLogic, recurringExpiry, recurringFrequency, recurringProcessingModel, redirectFromIssuerMethod, redirectToIssuerMethod, reference, returnUrl, riskData, shopperEmail, shopperIP, shopperInteraction, shopperLocale, shopperName, shopperReference, shopperStatement, showInstallmentAmount, socialSecurityNumber, splitCardFundingSources, splits, store, storePaymentMethod, storePaymentMethodMode, telephoneNumber, themeId, threeDSAuthenticationOnly, trustedShopper); + return Objects.hash(accountInfo, additionalAmount, additionalData, allowedPaymentMethods, amount, applicationInfo, authenticationData, billingAddress, blockedPaymentMethods, captureDelayHours, channel, company, countryCode, dateOfBirth, deliverAt, deliveryAddress, enableOneClick, enablePayOut, enableRecurring, expiresAt, fundOrigin, fundRecipient, installmentOptions, lineItems, mandate, mcc, merchantAccount, merchantOrderReference, metadata, mode, mpiData, platformChargebackLogic, recurringExpiry, recurringFrequency, recurringProcessingModel, redirectFromIssuerMethod, redirectToIssuerMethod, reference, returnUrl, riskData, shopperEmail, shopperIP, shopperInteraction, shopperLocale, shopperName, shopperReference, shopperStatement, showInstallmentAmount, showRemovePaymentMethodButton, socialSecurityNumber, splitCardFundingSources, splits, store, storePaymentMethod, storePaymentMethodMode, telephoneNumber, themeId, threeDSAuthenticationOnly, trustedShopper); } @Override @@ -2115,6 +2440,7 @@ public String toString() { sb.append(" shopperReference: ").append(toIndentedString(shopperReference)).append("\n"); sb.append(" shopperStatement: ").append(toIndentedString(shopperStatement)).append("\n"); sb.append(" showInstallmentAmount: ").append(toIndentedString(showInstallmentAmount)).append("\n"); + sb.append(" showRemovePaymentMethodButton: ").append(toIndentedString(showRemovePaymentMethodButton)).append("\n"); sb.append(" socialSecurityNumber: ").append(toIndentedString(socialSecurityNumber)).append("\n"); sb.append(" splitCardFundingSources: ").append(toIndentedString(splitCardFundingSources)).append("\n"); sb.append(" splits: ").append(toIndentedString(splits)).append("\n"); diff --git a/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionResponse.java b/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionResponse.java index 80d062cd1..a4871f35c 100644 --- a/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionResponse.java +++ b/src/main/java/com/adyen/model/checkout/CreateCheckoutSessionResponse.java @@ -103,6 +103,7 @@ CreateCheckoutSessionResponse.JSON_PROPERTY_SHOPPER_REFERENCE, CreateCheckoutSessionResponse.JSON_PROPERTY_SHOPPER_STATEMENT, CreateCheckoutSessionResponse.JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT, + CreateCheckoutSessionResponse.JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON, CreateCheckoutSessionResponse.JSON_PROPERTY_SOCIAL_SECURITY_NUMBER, CreateCheckoutSessionResponse.JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES, CreateCheckoutSessionResponse.JSON_PROPERTY_SPLITS, @@ -415,6 +416,9 @@ public static ShopperInteractionEnum fromValue(String value) { public static final String JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT = "showInstallmentAmount"; private Boolean showInstallmentAmount; + public static final String JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON = "showRemovePaymentMethodButton"; + private Boolean showRemovePaymentMethodButton; + public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER = "socialSecurityNumber"; private String socialSecurityNumber; @@ -506,6 +510,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -531,6 +540,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -564,6 +578,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -597,6 +616,11 @@ public List getAllowedPaymentMethods() { } + /** + * List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param allowedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_ALLOWED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedPaymentMethods(List allowedPaymentMethods) { @@ -622,6 +646,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -647,6 +676,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -672,6 +706,11 @@ public AuthenticationData getAuthenticationData() { } + /** + * authenticationData + * + * @param authenticationData + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationData(AuthenticationData authenticationData) { @@ -697,6 +736,11 @@ public BillingAddress getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(BillingAddress billingAddress) { @@ -730,6 +774,11 @@ public List getBlockedPaymentMethods() { } + /** + * List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param blockedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_BLOCKED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlockedPaymentMethods(List blockedPaymentMethods) { @@ -755,6 +804,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -780,6 +834,11 @@ public ChannelEnum getChannel() { } + /** + * The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * **iOS** * **Android** * **Web** + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(ChannelEnum channel) { @@ -805,6 +864,11 @@ public Company getCompany() { } + /** + * company + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(Company company) { @@ -830,6 +894,11 @@ public String getCountryCode() { } + /** + * The shopper's two-letter country code. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -855,6 +924,11 @@ public OffsetDateTime getDateOfBirth() { } + /** + * The shopper's date of birth in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(OffsetDateTime dateOfBirth) { @@ -880,6 +954,11 @@ public OffsetDateTime getDeliverAt() { } + /** + * The date and time when the purchased goods should be delivered. [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**. + * + * @param deliverAt + */ @JsonProperty(JSON_PROPERTY_DELIVER_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliverAt(OffsetDateTime deliverAt) { @@ -905,6 +984,11 @@ public DeliveryAddress getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(DeliveryAddress deliveryAddress) { @@ -930,6 +1014,11 @@ public Boolean getEnableOneClick() { } + /** + * When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments. + * + * @param enableOneClick + */ @JsonProperty(JSON_PROPERTY_ENABLE_ONE_CLICK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableOneClick(Boolean enableOneClick) { @@ -955,6 +1044,11 @@ public Boolean getEnablePayOut() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for payouts. + * + * @param enablePayOut + */ @JsonProperty(JSON_PROPERTY_ENABLE_PAY_OUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnablePayOut(Boolean enablePayOut) { @@ -980,6 +1074,11 @@ public Boolean getEnableRecurring() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. + * + * @param enableRecurring + */ @JsonProperty(JSON_PROPERTY_ENABLE_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableRecurring(Boolean enableRecurring) { @@ -1005,6 +1104,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date the session expires in [ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. When not specified, the expiry date is set to 1 hour after session creation. You cannot set the session expiry to more than 24 hours after session creation. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { @@ -1030,6 +1134,11 @@ public FundOrigin getFundOrigin() { } + /** + * fundOrigin + * + * @param fundOrigin + */ @JsonProperty(JSON_PROPERTY_FUND_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundOrigin(FundOrigin fundOrigin) { @@ -1055,6 +1164,11 @@ public FundRecipient getFundRecipient() { } + /** + * fundRecipient + * + * @param fundRecipient + */ @JsonProperty(JSON_PROPERTY_FUND_RECIPIENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundRecipient(FundRecipient fundRecipient) { @@ -1080,6 +1194,11 @@ public String getId() { } + /** + * A unique identifier of the session. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -1113,6 +1232,11 @@ public Map getInstallmentOptions() { } + /** + * A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options. + * + * @param installmentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentOptions(Map installmentOptions) { @@ -1146,6 +1270,11 @@ public List getLineItems() { } + /** + * Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -1171,6 +1300,11 @@ public Mandate getMandate() { } + /** + * mandate + * + * @param mandate + */ @JsonProperty(JSON_PROPERTY_MANDATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMandate(Mandate mandate) { @@ -1196,6 +1330,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -1221,6 +1360,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -1246,6 +1390,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -1279,6 +1428,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -1304,6 +1458,11 @@ public ModeEnum getMode() { } + /** + * Indicates the type of front end integration. Possible values: * **embedded** (default): Drop-in or Components integration * **hosted**: Hosted Checkout integration + * + * @param mode + */ @JsonProperty(JSON_PROPERTY_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMode(ModeEnum mode) { @@ -1329,6 +1488,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -1354,6 +1518,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -1379,6 +1548,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -1404,6 +1578,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -1429,6 +1608,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1454,6 +1638,11 @@ public String getRedirectFromIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting back from the issuer. + * + * @param redirectFromIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod) { @@ -1479,6 +1668,11 @@ public String getRedirectToIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting to the issuer. + * + * @param redirectToIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectToIssuerMethod(String redirectToIssuerMethod) { @@ -1504,6 +1698,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1529,6 +1728,11 @@ public String getReturnUrl() { } + /** + * The URL to return to when a redirect payment is completed. + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -1554,6 +1758,11 @@ public RiskData getRiskData() { } + /** + * riskData + * + * @param riskData + */ @JsonProperty(JSON_PROPERTY_RISK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskData(RiskData riskData) { @@ -1579,6 +1788,11 @@ public String getSessionData() { } + /** + * The payment session data you need to pass to your front end. + * + * @param sessionData + */ @JsonProperty(JSON_PROPERTY_SESSION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionData(String sessionData) { @@ -1604,6 +1818,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1629,6 +1848,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1654,6 +1878,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1679,6 +1908,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1704,6 +1938,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1729,6 +1968,11 @@ public String getShopperReference() { } + /** + * Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1754,6 +1998,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1779,6 +2028,11 @@ public Boolean getShowInstallmentAmount() { } + /** + * Set to true to show the payment amount per installment. + * + * @param showInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_SHOW_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShowInstallmentAmount(Boolean showInstallmentAmount) { @@ -1786,6 +2040,36 @@ public void setShowInstallmentAmount(Boolean showInstallmentAmount) { } + public CreateCheckoutSessionResponse showRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) { + this.showRemovePaymentMethodButton = showRemovePaymentMethodButton; + return this; + } + + /** + * Set to **true** to show a button that lets the shopper remove a stored payment method. + * @return showRemovePaymentMethodButton + **/ + @ApiModelProperty(value = "Set to **true** to show a button that lets the shopper remove a stored payment method.") + @JsonProperty(JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getShowRemovePaymentMethodButton() { + return showRemovePaymentMethodButton; + } + + + /** + * Set to **true** to show a button that lets the shopper remove a stored payment method. + * + * @param showRemovePaymentMethodButton + */ + @JsonProperty(JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) { + this.showRemovePaymentMethodButton = showRemovePaymentMethodButton; + } + + public CreateCheckoutSessionResponse socialSecurityNumber(String socialSecurityNumber) { this.socialSecurityNumber = socialSecurityNumber; return this; @@ -1804,6 +2088,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1829,6 +2118,11 @@ public Boolean getSplitCardFundingSources() { } + /** + * Boolean value indicating whether the card payment method should be split into separate debit and credit options. + * + * @param splitCardFundingSources + */ @JsonProperty(JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitCardFundingSources(Boolean splitCardFundingSources) { @@ -1862,6 +2156,11 @@ public List getSplits() { } + /** + * An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1887,6 +2186,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1912,6 +2216,11 @@ public Boolean getStorePaymentMethod() { } + /** + * When this is set to **true** and the `shopperReference` is provided, the payment details will be stored. + * + * @param storePaymentMethod + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethod(Boolean storePaymentMethod) { @@ -1937,6 +2246,11 @@ public StorePaymentMethodModeEnum getStorePaymentMethodMode() { } + /** + * Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. + * + * @param storePaymentMethodMode + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethodMode(StorePaymentMethodModeEnum storePaymentMethodMode) { @@ -1962,6 +2276,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1987,6 +2306,11 @@ public String getThemeId() { } + /** + * Sets a custom theme for [Hosted Checkout](https://docs.adyen.com/online-payments/build-your-integration/?platform=Web&integration=Hosted+Checkout). The value can be any of the **Theme ID** values from your Customer Area. + * + * @param themeId + */ @JsonProperty(JSON_PROPERTY_THEME_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThemeId(String themeId) { @@ -2014,6 +2338,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -2040,6 +2369,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { @@ -2065,6 +2399,11 @@ public String getUrl() { } + /** + * The URL for the Hosted Checkout page. Redirect the shopper to this URL so they can make the payment. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -2134,6 +2473,7 @@ public boolean equals(Object o) { Objects.equals(this.shopperReference, createCheckoutSessionResponse.shopperReference) && Objects.equals(this.shopperStatement, createCheckoutSessionResponse.shopperStatement) && Objects.equals(this.showInstallmentAmount, createCheckoutSessionResponse.showInstallmentAmount) && + Objects.equals(this.showRemovePaymentMethodButton, createCheckoutSessionResponse.showRemovePaymentMethodButton) && Objects.equals(this.socialSecurityNumber, createCheckoutSessionResponse.socialSecurityNumber) && Objects.equals(this.splitCardFundingSources, createCheckoutSessionResponse.splitCardFundingSources) && Objects.equals(this.splits, createCheckoutSessionResponse.splits) && @@ -2149,7 +2489,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(accountInfo, additionalAmount, additionalData, allowedPaymentMethods, amount, applicationInfo, authenticationData, billingAddress, blockedPaymentMethods, captureDelayHours, channel, company, countryCode, dateOfBirth, deliverAt, deliveryAddress, enableOneClick, enablePayOut, enableRecurring, expiresAt, fundOrigin, fundRecipient, id, installmentOptions, lineItems, mandate, mcc, merchantAccount, merchantOrderReference, metadata, mode, mpiData, platformChargebackLogic, recurringExpiry, recurringFrequency, recurringProcessingModel, redirectFromIssuerMethod, redirectToIssuerMethod, reference, returnUrl, riskData, sessionData, shopperEmail, shopperIP, shopperInteraction, shopperLocale, shopperName, shopperReference, shopperStatement, showInstallmentAmount, socialSecurityNumber, splitCardFundingSources, splits, store, storePaymentMethod, storePaymentMethodMode, telephoneNumber, themeId, threeDSAuthenticationOnly, trustedShopper, url); + return Objects.hash(accountInfo, additionalAmount, additionalData, allowedPaymentMethods, amount, applicationInfo, authenticationData, billingAddress, blockedPaymentMethods, captureDelayHours, channel, company, countryCode, dateOfBirth, deliverAt, deliveryAddress, enableOneClick, enablePayOut, enableRecurring, expiresAt, fundOrigin, fundRecipient, id, installmentOptions, lineItems, mandate, mcc, merchantAccount, merchantOrderReference, metadata, mode, mpiData, platformChargebackLogic, recurringExpiry, recurringFrequency, recurringProcessingModel, redirectFromIssuerMethod, redirectToIssuerMethod, reference, returnUrl, riskData, sessionData, shopperEmail, shopperIP, shopperInteraction, shopperLocale, shopperName, shopperReference, shopperStatement, showInstallmentAmount, showRemovePaymentMethodButton, socialSecurityNumber, splitCardFundingSources, splits, store, storePaymentMethod, storePaymentMethodMode, telephoneNumber, themeId, threeDSAuthenticationOnly, trustedShopper, url); } @Override @@ -2206,6 +2546,7 @@ public String toString() { sb.append(" shopperReference: ").append(toIndentedString(shopperReference)).append("\n"); sb.append(" shopperStatement: ").append(toIndentedString(shopperStatement)).append("\n"); sb.append(" showInstallmentAmount: ").append(toIndentedString(showInstallmentAmount)).append("\n"); + sb.append(" showRemovePaymentMethodButton: ").append(toIndentedString(showRemovePaymentMethodButton)).append("\n"); sb.append(" socialSecurityNumber: ").append(toIndentedString(socialSecurityNumber)).append("\n"); sb.append(" splitCardFundingSources: ").append(toIndentedString(splitCardFundingSources)).append("\n"); sb.append(" splits: ").append(toIndentedString(splits)).append("\n"); diff --git a/src/main/java/com/adyen/model/checkout/CreateOrderRequest.java b/src/main/java/com/adyen/model/checkout/CreateOrderRequest.java index ba0e34e3f..c97719037 100644 --- a/src/main/java/com/adyen/model/checkout/CreateOrderRequest.java +++ b/src/main/java/com/adyen/model/checkout/CreateOrderRequest.java @@ -72,6 +72,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -97,6 +102,11 @@ public String getExpiresAt() { } + /** + * The date that order expires; e.g. 2019-03-23T12:25:28Z. If not provided, the default expiry duration is 1 day. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(String expiresAt) { @@ -122,6 +132,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the order. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -147,6 +162,11 @@ public String getReference() { } + /** + * A custom reference identifying the order. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/checkout/CreateOrderResponse.java b/src/main/java/com/adyen/model/checkout/CreateOrderResponse.java index f119079ea..0c5e429fd 100644 --- a/src/main/java/com/adyen/model/checkout/CreateOrderResponse.java +++ b/src/main/java/com/adyen/model/checkout/CreateOrderResponse.java @@ -141,6 +141,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -166,6 +171,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -191,6 +201,11 @@ public String getExpiresAt() { } + /** + * The date that the order will expire. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(String expiresAt) { @@ -216,6 +231,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -241,6 +261,11 @@ public String getOrderData() { } + /** + * The encrypted data that will be used by merchant for adding payments to the order. + * + * @param orderData + */ @JsonProperty(JSON_PROPERTY_ORDER_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderData(String orderData) { @@ -266,6 +291,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -291,6 +321,11 @@ public String getReference() { } + /** + * The reference provided by merchant for creating the order. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -316,6 +351,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -341,6 +381,11 @@ public Amount getRemainingAmount() { } + /** + * remainingAmount + * + * @param remainingAmount + */ @JsonProperty(JSON_PROPERTY_REMAINING_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemainingAmount(Amount remainingAmount) { @@ -366,6 +411,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the order creation request. The value is always **Success**. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { diff --git a/src/main/java/com/adyen/model/checkout/DeliveryAddress.java b/src/main/java/com/adyen/model/checkout/DeliveryAddress.java index 021eeee30..263ef5e3a 100644 --- a/src/main/java/com/adyen/model/checkout/DeliveryAddress.java +++ b/src/main/java/com/adyen/model/checkout/DeliveryAddress.java @@ -87,6 +87,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -112,6 +117,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -137,6 +147,11 @@ public String getFirstName() { } + /** + * firstName + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -162,6 +177,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -187,6 +207,11 @@ public String getLastName() { } + /** + * lastName + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -212,6 +237,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -237,6 +267,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -262,6 +297,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/checkout/DetailsRequestAuthenticationData.java b/src/main/java/com/adyen/model/checkout/DetailsRequestAuthenticationData.java index 3019f9e57..1441620de 100644 --- a/src/main/java/com/adyen/model/checkout/DetailsRequestAuthenticationData.java +++ b/src/main/java/com/adyen/model/checkout/DetailsRequestAuthenticationData.java @@ -59,6 +59,11 @@ public Boolean getAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. Default: *false**. + * + * @param authenticationOnly + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationOnly(Boolean authenticationOnly) { diff --git a/src/main/java/com/adyen/model/checkout/DeviceRenderOptions.java b/src/main/java/com/adyen/model/checkout/DeviceRenderOptions.java index 763475974..36fbb2b2f 100644 --- a/src/main/java/com/adyen/model/checkout/DeviceRenderOptions.java +++ b/src/main/java/com/adyen/model/checkout/DeviceRenderOptions.java @@ -143,6 +143,11 @@ public SdkInterfaceEnum getSdkInterface() { } + /** + * Supported SDK interface types. Allowed values: * native * html * both + * + * @param sdkInterface + */ @JsonProperty(JSON_PROPERTY_SDK_INTERFACE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkInterface(SdkInterfaceEnum sdkInterface) { @@ -176,6 +181,11 @@ public List getSdkUiType() { } + /** + * UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect + * + * @param sdkUiType + */ @JsonProperty(JSON_PROPERTY_SDK_UI_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkUiType(List sdkUiType) { diff --git a/src/main/java/com/adyen/model/checkout/DokuDetails.java b/src/main/java/com/adyen/model/checkout/DokuDetails.java index c18ed051f..d7ebea50f 100644 --- a/src/main/java/com/adyen/model/checkout/DokuDetails.java +++ b/src/main/java/com/adyen/model/checkout/DokuDetails.java @@ -128,6 +128,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -153,6 +158,11 @@ public String getFirstName() { } + /** + * The shopper's first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -178,6 +188,11 @@ public String getLastName() { } + /** + * The shopper's last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -203,6 +218,11 @@ public String getShopperEmail() { } + /** + * The shopper's email. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -228,6 +248,11 @@ public TypeEnum getType() { } + /** + * **doku** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/DonationPaymentMethod.java b/src/main/java/com/adyen/model/checkout/DonationPaymentMethod.java index 79a6117e0..ea4737ddb 100644 --- a/src/main/java/com/adyen/model/checkout/DonationPaymentMethod.java +++ b/src/main/java/com/adyen/model/checkout/DonationPaymentMethod.java @@ -16,11 +16,11 @@ import java.util.Arrays; import java.util.Map; import java.util.HashMap; -import com.adyen.model.checkout.ApplePayDetails; -import com.adyen.model.checkout.CardDetails; -import com.adyen.model.checkout.GooglePayDetails; -import com.adyen.model.checkout.IdealDetails; -import com.adyen.model.checkout.PayWithGoogleDetails; +import com.adyen.model.checkout.ApplePayDonations; +import com.adyen.model.checkout.CardDonations; +import com.adyen.model.checkout.GooglePayDonations; +import com.adyen.model.checkout.IdealDonations; +import com.adyen.model.checkout.PayWithGoogleDonations; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; import com.fasterxml.jackson.annotation.JsonCreator; @@ -97,143 +97,143 @@ public DonationPaymentMethod deserialize(JsonParser jp, DeserializationContext c int match = 0; JsonToken token = tree.traverse(jp.getCodec()).nextToken(); - // deserialize ApplePayDetails + // deserialize ApplePayDonations try { boolean attemptParsing = true; // ensure that we respect type coercion as set on the client ObjectMapper - if (ApplePayDetails.class.equals(Integer.class) || ApplePayDetails.class.equals(Long.class) || ApplePayDetails.class.equals(Float.class) || ApplePayDetails.class.equals(Double.class) || ApplePayDetails.class.equals(Boolean.class) || ApplePayDetails.class.equals(String.class)) { + if (ApplePayDonations.class.equals(Integer.class) || ApplePayDonations.class.equals(Long.class) || ApplePayDonations.class.equals(Float.class) || ApplePayDonations.class.equals(Double.class) || ApplePayDonations.class.equals(Boolean.class) || ApplePayDonations.class.equals(String.class)) { attemptParsing = typeCoercion; if (!attemptParsing) { - attemptParsing |= ((ApplePayDetails.class.equals(Integer.class) || ApplePayDetails.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); - attemptParsing |= ((ApplePayDetails.class.equals(Float.class) || ApplePayDetails.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); - attemptParsing |= (ApplePayDetails.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); - attemptParsing |= (ApplePayDetails.class.equals(String.class) && token == JsonToken.VALUE_STRING); + attemptParsing |= ((ApplePayDonations.class.equals(Integer.class) || ApplePayDonations.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((ApplePayDonations.class.equals(Float.class) || ApplePayDonations.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (ApplePayDonations.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (ApplePayDonations.class.equals(String.class) && token == JsonToken.VALUE_STRING); } } // Checks if the unique type of the oneOf json matches any of the object TypeEnum values - boolean typeMatch = Arrays.stream(ApplePayDetails.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); + boolean typeMatch = Arrays.stream(ApplePayDonations.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); if (attemptParsing || typeMatch) { // Strict deserialization for oneOf models - deserialized = JSON.getMapper().readValue(tree.toString(), ApplePayDetails.class); + deserialized = JSON.getMapper().readValue(tree.toString(), ApplePayDonations.class); // typeMatch should enforce proper deserialization match++; - log.log(Level.FINER, "Input data matches schema 'ApplePayDetails'"); + log.log(Level.FINER, "Input data matches schema 'ApplePayDonations'"); } } catch (Exception e) { // deserialization failed, continue - log.log(Level.FINER, "Input data does not match schema 'ApplePayDetails'", e); + log.log(Level.FINER, "Input data does not match schema 'ApplePayDonations'", e); } - // deserialize CardDetails + // deserialize CardDonations try { boolean attemptParsing = true; // ensure that we respect type coercion as set on the client ObjectMapper - if (CardDetails.class.equals(Integer.class) || CardDetails.class.equals(Long.class) || CardDetails.class.equals(Float.class) || CardDetails.class.equals(Double.class) || CardDetails.class.equals(Boolean.class) || CardDetails.class.equals(String.class)) { + if (CardDonations.class.equals(Integer.class) || CardDonations.class.equals(Long.class) || CardDonations.class.equals(Float.class) || CardDonations.class.equals(Double.class) || CardDonations.class.equals(Boolean.class) || CardDonations.class.equals(String.class)) { attemptParsing = typeCoercion; if (!attemptParsing) { - attemptParsing |= ((CardDetails.class.equals(Integer.class) || CardDetails.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); - attemptParsing |= ((CardDetails.class.equals(Float.class) || CardDetails.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); - attemptParsing |= (CardDetails.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); - attemptParsing |= (CardDetails.class.equals(String.class) && token == JsonToken.VALUE_STRING); + attemptParsing |= ((CardDonations.class.equals(Integer.class) || CardDonations.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((CardDonations.class.equals(Float.class) || CardDonations.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (CardDonations.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (CardDonations.class.equals(String.class) && token == JsonToken.VALUE_STRING); } } // Checks if the unique type of the oneOf json matches any of the object TypeEnum values - boolean typeMatch = Arrays.stream(CardDetails.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); + boolean typeMatch = Arrays.stream(CardDonations.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); if (attemptParsing || typeMatch) { // Strict deserialization for oneOf models - deserialized = JSON.getMapper().readValue(tree.toString(), CardDetails.class); + deserialized = JSON.getMapper().readValue(tree.toString(), CardDonations.class); // typeMatch should enforce proper deserialization match++; - log.log(Level.FINER, "Input data matches schema 'CardDetails'"); + log.log(Level.FINER, "Input data matches schema 'CardDonations'"); } } catch (Exception e) { // deserialization failed, continue - log.log(Level.FINER, "Input data does not match schema 'CardDetails'", e); + log.log(Level.FINER, "Input data does not match schema 'CardDonations'", e); } - // deserialize GooglePayDetails + // deserialize GooglePayDonations try { boolean attemptParsing = true; // ensure that we respect type coercion as set on the client ObjectMapper - if (GooglePayDetails.class.equals(Integer.class) || GooglePayDetails.class.equals(Long.class) || GooglePayDetails.class.equals(Float.class) || GooglePayDetails.class.equals(Double.class) || GooglePayDetails.class.equals(Boolean.class) || GooglePayDetails.class.equals(String.class)) { + if (GooglePayDonations.class.equals(Integer.class) || GooglePayDonations.class.equals(Long.class) || GooglePayDonations.class.equals(Float.class) || GooglePayDonations.class.equals(Double.class) || GooglePayDonations.class.equals(Boolean.class) || GooglePayDonations.class.equals(String.class)) { attemptParsing = typeCoercion; if (!attemptParsing) { - attemptParsing |= ((GooglePayDetails.class.equals(Integer.class) || GooglePayDetails.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); - attemptParsing |= ((GooglePayDetails.class.equals(Float.class) || GooglePayDetails.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); - attemptParsing |= (GooglePayDetails.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); - attemptParsing |= (GooglePayDetails.class.equals(String.class) && token == JsonToken.VALUE_STRING); + attemptParsing |= ((GooglePayDonations.class.equals(Integer.class) || GooglePayDonations.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((GooglePayDonations.class.equals(Float.class) || GooglePayDonations.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (GooglePayDonations.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (GooglePayDonations.class.equals(String.class) && token == JsonToken.VALUE_STRING); } } // Checks if the unique type of the oneOf json matches any of the object TypeEnum values - boolean typeMatch = Arrays.stream(GooglePayDetails.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); + boolean typeMatch = Arrays.stream(GooglePayDonations.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); if (attemptParsing || typeMatch) { // Strict deserialization for oneOf models - deserialized = JSON.getMapper().readValue(tree.toString(), GooglePayDetails.class); + deserialized = JSON.getMapper().readValue(tree.toString(), GooglePayDonations.class); // typeMatch should enforce proper deserialization match++; - log.log(Level.FINER, "Input data matches schema 'GooglePayDetails'"); + log.log(Level.FINER, "Input data matches schema 'GooglePayDonations'"); } } catch (Exception e) { // deserialization failed, continue - log.log(Level.FINER, "Input data does not match schema 'GooglePayDetails'", e); + log.log(Level.FINER, "Input data does not match schema 'GooglePayDonations'", e); } - // deserialize IdealDetails + // deserialize IdealDonations try { boolean attemptParsing = true; // ensure that we respect type coercion as set on the client ObjectMapper - if (IdealDetails.class.equals(Integer.class) || IdealDetails.class.equals(Long.class) || IdealDetails.class.equals(Float.class) || IdealDetails.class.equals(Double.class) || IdealDetails.class.equals(Boolean.class) || IdealDetails.class.equals(String.class)) { + if (IdealDonations.class.equals(Integer.class) || IdealDonations.class.equals(Long.class) || IdealDonations.class.equals(Float.class) || IdealDonations.class.equals(Double.class) || IdealDonations.class.equals(Boolean.class) || IdealDonations.class.equals(String.class)) { attemptParsing = typeCoercion; if (!attemptParsing) { - attemptParsing |= ((IdealDetails.class.equals(Integer.class) || IdealDetails.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); - attemptParsing |= ((IdealDetails.class.equals(Float.class) || IdealDetails.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); - attemptParsing |= (IdealDetails.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); - attemptParsing |= (IdealDetails.class.equals(String.class) && token == JsonToken.VALUE_STRING); + attemptParsing |= ((IdealDonations.class.equals(Integer.class) || IdealDonations.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((IdealDonations.class.equals(Float.class) || IdealDonations.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (IdealDonations.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (IdealDonations.class.equals(String.class) && token == JsonToken.VALUE_STRING); } } // Checks if the unique type of the oneOf json matches any of the object TypeEnum values - boolean typeMatch = Arrays.stream(IdealDetails.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); + boolean typeMatch = Arrays.stream(IdealDonations.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); if (attemptParsing || typeMatch) { // Strict deserialization for oneOf models - deserialized = JSON.getMapper().readValue(tree.toString(), IdealDetails.class); + deserialized = JSON.getMapper().readValue(tree.toString(), IdealDonations.class); // typeMatch should enforce proper deserialization match++; - log.log(Level.FINER, "Input data matches schema 'IdealDetails'"); + log.log(Level.FINER, "Input data matches schema 'IdealDonations'"); } } catch (Exception e) { // deserialization failed, continue - log.log(Level.FINER, "Input data does not match schema 'IdealDetails'", e); + log.log(Level.FINER, "Input data does not match schema 'IdealDonations'", e); } - // deserialize PayWithGoogleDetails + // deserialize PayWithGoogleDonations try { boolean attemptParsing = true; // ensure that we respect type coercion as set on the client ObjectMapper - if (PayWithGoogleDetails.class.equals(Integer.class) || PayWithGoogleDetails.class.equals(Long.class) || PayWithGoogleDetails.class.equals(Float.class) || PayWithGoogleDetails.class.equals(Double.class) || PayWithGoogleDetails.class.equals(Boolean.class) || PayWithGoogleDetails.class.equals(String.class)) { + if (PayWithGoogleDonations.class.equals(Integer.class) || PayWithGoogleDonations.class.equals(Long.class) || PayWithGoogleDonations.class.equals(Float.class) || PayWithGoogleDonations.class.equals(Double.class) || PayWithGoogleDonations.class.equals(Boolean.class) || PayWithGoogleDonations.class.equals(String.class)) { attemptParsing = typeCoercion; if (!attemptParsing) { - attemptParsing |= ((PayWithGoogleDetails.class.equals(Integer.class) || PayWithGoogleDetails.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); - attemptParsing |= ((PayWithGoogleDetails.class.equals(Float.class) || PayWithGoogleDetails.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); - attemptParsing |= (PayWithGoogleDetails.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); - attemptParsing |= (PayWithGoogleDetails.class.equals(String.class) && token == JsonToken.VALUE_STRING); + attemptParsing |= ((PayWithGoogleDonations.class.equals(Integer.class) || PayWithGoogleDonations.class.equals(Long.class)) && token == JsonToken.VALUE_NUMBER_INT); + attemptParsing |= ((PayWithGoogleDonations.class.equals(Float.class) || PayWithGoogleDonations.class.equals(Double.class)) && token == JsonToken.VALUE_NUMBER_FLOAT); + attemptParsing |= (PayWithGoogleDonations.class.equals(Boolean.class) && (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (PayWithGoogleDonations.class.equals(String.class) && token == JsonToken.VALUE_STRING); } } // Checks if the unique type of the oneOf json matches any of the object TypeEnum values - boolean typeMatch = Arrays.stream(PayWithGoogleDetails.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); + boolean typeMatch = Arrays.stream(PayWithGoogleDonations.TypeEnum.values()).anyMatch((t) -> t.getValue().contains(tree.findValue("type").asText())); if (attemptParsing || typeMatch) { // Strict deserialization for oneOf models - deserialized = JSON.getMapper().readValue(tree.toString(), PayWithGoogleDetails.class); + deserialized = JSON.getMapper().readValue(tree.toString(), PayWithGoogleDonations.class); // typeMatch should enforce proper deserialization match++; - log.log(Level.FINER, "Input data matches schema 'PayWithGoogleDetails'"); + log.log(Level.FINER, "Input data matches schema 'PayWithGoogleDonations'"); } } catch (Exception e) { // deserialization failed, continue - log.log(Level.FINER, "Input data does not match schema 'PayWithGoogleDetails'", e); + log.log(Level.FINER, "Input data does not match schema 'PayWithGoogleDonations'", e); } // Throw error if there is no match @@ -266,41 +266,41 @@ public DonationPaymentMethod() { super("oneOf", Boolean.FALSE); } - public DonationPaymentMethod(ApplePayDetails o) { + public DonationPaymentMethod(ApplePayDonations o) { super("oneOf", Boolean.FALSE); setActualInstance(o); } - public DonationPaymentMethod(CardDetails o) { + public DonationPaymentMethod(CardDonations o) { super("oneOf", Boolean.FALSE); setActualInstance(o); } - public DonationPaymentMethod(GooglePayDetails o) { + public DonationPaymentMethod(GooglePayDonations o) { super("oneOf", Boolean.FALSE); setActualInstance(o); } - public DonationPaymentMethod(IdealDetails o) { + public DonationPaymentMethod(IdealDonations o) { super("oneOf", Boolean.FALSE); setActualInstance(o); } - public DonationPaymentMethod(PayWithGoogleDetails o) { + public DonationPaymentMethod(PayWithGoogleDonations o) { super("oneOf", Boolean.FALSE); setActualInstance(o); } static { - schemas.put("ApplePayDetails", new GenericType() { + schemas.put("ApplePayDonations", new GenericType() { }); - schemas.put("CardDetails", new GenericType() { + schemas.put("CardDonations", new GenericType() { }); - schemas.put("GooglePayDetails", new GenericType() { + schemas.put("GooglePayDonations", new GenericType() { }); - schemas.put("IdealDetails", new GenericType() { + schemas.put("IdealDonations", new GenericType() { }); - schemas.put("PayWithGoogleDetails", new GenericType() { + schemas.put("PayWithGoogleDonations", new GenericType() { }); JSON.registerDescendants(DonationPaymentMethod.class, Collections.unmodifiableMap(schemas)); } @@ -313,46 +313,46 @@ public Map getSchemas() { /** * Set the instance that matches the oneOf child schema, check * the instance parameter is valid against the oneOf child schemas: - * ApplePayDetails, CardDetails, GooglePayDetails, IdealDetails, PayWithGoogleDetails + * ApplePayDonations, CardDonations, GooglePayDonations, IdealDonations, PayWithGoogleDonations * * It could be an instance of the 'oneOf' schemas. * The oneOf child schemas may themselves be a composed schema (allOf, anyOf, oneOf). */ @Override public void setActualInstance(Object instance) { - if (JSON.isInstanceOf(ApplePayDetails.class, instance, new HashSet>())) { + if (JSON.isInstanceOf(ApplePayDonations.class, instance, new HashSet>())) { super.setActualInstance(instance); return; } - if (JSON.isInstanceOf(CardDetails.class, instance, new HashSet>())) { + if (JSON.isInstanceOf(CardDonations.class, instance, new HashSet>())) { super.setActualInstance(instance); return; } - if (JSON.isInstanceOf(GooglePayDetails.class, instance, new HashSet>())) { + if (JSON.isInstanceOf(GooglePayDonations.class, instance, new HashSet>())) { super.setActualInstance(instance); return; } - if (JSON.isInstanceOf(IdealDetails.class, instance, new HashSet>())) { + if (JSON.isInstanceOf(IdealDonations.class, instance, new HashSet>())) { super.setActualInstance(instance); return; } - if (JSON.isInstanceOf(PayWithGoogleDetails.class, instance, new HashSet>())) { + if (JSON.isInstanceOf(PayWithGoogleDonations.class, instance, new HashSet>())) { super.setActualInstance(instance); return; } - throw new RuntimeException("Invalid instance type. Must be ApplePayDetails, CardDetails, GooglePayDetails, IdealDetails, PayWithGoogleDetails"); + throw new RuntimeException("Invalid instance type. Must be ApplePayDonations, CardDonations, GooglePayDonations, IdealDonations, PayWithGoogleDonations"); } /** * Get the actual instance, which can be the following: - * ApplePayDetails, CardDetails, GooglePayDetails, IdealDetails, PayWithGoogleDetails + * ApplePayDonations, CardDonations, GooglePayDonations, IdealDonations, PayWithGoogleDonations * - * @return The actual instance (ApplePayDetails, CardDetails, GooglePayDetails, IdealDetails, PayWithGoogleDetails) + * @return The actual instance (ApplePayDonations, CardDonations, GooglePayDonations, IdealDonations, PayWithGoogleDonations) */ @Override public Object getActualInstance() { @@ -360,58 +360,58 @@ public Object getActualInstance() { } /** - * Get the actual instance of `ApplePayDetails`. If the actual instance is not `ApplePayDetails`, + * Get the actual instance of `ApplePayDonations`. If the actual instance is not `ApplePayDonations`, * the ClassCastException will be thrown. * - * @return The actual instance of `ApplePayDetails` - * @throws ClassCastException if the instance is not `ApplePayDetails` + * @return The actual instance of `ApplePayDonations` + * @throws ClassCastException if the instance is not `ApplePayDonations` */ - public ApplePayDetails getApplePayDetails() throws ClassCastException { - return (ApplePayDetails)super.getActualInstance(); + public ApplePayDonations getApplePayDonations() throws ClassCastException { + return (ApplePayDonations)super.getActualInstance(); } /** - * Get the actual instance of `CardDetails`. If the actual instance is not `CardDetails`, + * Get the actual instance of `CardDonations`. If the actual instance is not `CardDonations`, * the ClassCastException will be thrown. * - * @return The actual instance of `CardDetails` - * @throws ClassCastException if the instance is not `CardDetails` + * @return The actual instance of `CardDonations` + * @throws ClassCastException if the instance is not `CardDonations` */ - public CardDetails getCardDetails() throws ClassCastException { - return (CardDetails)super.getActualInstance(); + public CardDonations getCardDonations() throws ClassCastException { + return (CardDonations)super.getActualInstance(); } /** - * Get the actual instance of `GooglePayDetails`. If the actual instance is not `GooglePayDetails`, + * Get the actual instance of `GooglePayDonations`. If the actual instance is not `GooglePayDonations`, * the ClassCastException will be thrown. * - * @return The actual instance of `GooglePayDetails` - * @throws ClassCastException if the instance is not `GooglePayDetails` + * @return The actual instance of `GooglePayDonations` + * @throws ClassCastException if the instance is not `GooglePayDonations` */ - public GooglePayDetails getGooglePayDetails() throws ClassCastException { - return (GooglePayDetails)super.getActualInstance(); + public GooglePayDonations getGooglePayDonations() throws ClassCastException { + return (GooglePayDonations)super.getActualInstance(); } /** - * Get the actual instance of `IdealDetails`. If the actual instance is not `IdealDetails`, + * Get the actual instance of `IdealDonations`. If the actual instance is not `IdealDonations`, * the ClassCastException will be thrown. * - * @return The actual instance of `IdealDetails` - * @throws ClassCastException if the instance is not `IdealDetails` + * @return The actual instance of `IdealDonations` + * @throws ClassCastException if the instance is not `IdealDonations` */ - public IdealDetails getIdealDetails() throws ClassCastException { - return (IdealDetails)super.getActualInstance(); + public IdealDonations getIdealDonations() throws ClassCastException { + return (IdealDonations)super.getActualInstance(); } /** - * Get the actual instance of `PayWithGoogleDetails`. If the actual instance is not `PayWithGoogleDetails`, + * Get the actual instance of `PayWithGoogleDonations`. If the actual instance is not `PayWithGoogleDonations`, * the ClassCastException will be thrown. * - * @return The actual instance of `PayWithGoogleDetails` - * @throws ClassCastException if the instance is not `PayWithGoogleDetails` + * @return The actual instance of `PayWithGoogleDonations` + * @throws ClassCastException if the instance is not `PayWithGoogleDonations` */ - public PayWithGoogleDetails getPayWithGoogleDetails() throws ClassCastException { - return (PayWithGoogleDetails)super.getActualInstance(); + public PayWithGoogleDonations getPayWithGoogleDonations() throws ClassCastException { + return (PayWithGoogleDonations)super.getActualInstance(); } /** diff --git a/src/main/java/com/adyen/model/checkout/DonationPaymentRequest.java b/src/main/java/com/adyen/model/checkout/DonationPaymentRequest.java index da2ae901e..88bf293bc 100644 --- a/src/main/java/com/adyen/model/checkout/DonationPaymentRequest.java +++ b/src/main/java/com/adyen/model/checkout/DonationPaymentRequest.java @@ -350,6 +350,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -383,6 +388,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -408,6 +418,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -433,6 +448,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -458,6 +478,11 @@ public AuthenticationData getAuthenticationData() { } + /** + * authenticationData + * + * @param authenticationData + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationData(AuthenticationData authenticationData) { @@ -483,6 +508,11 @@ public BillingAddress getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(BillingAddress billingAddress) { @@ -508,6 +538,11 @@ public BrowserInfo getBrowserInfo() { } + /** + * browserInfo + * + * @param browserInfo + */ @JsonProperty(JSON_PROPERTY_BROWSER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrowserInfo(BrowserInfo browserInfo) { @@ -533,6 +568,11 @@ public ChannelEnum getChannel() { } + /** + * The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(ChannelEnum channel) { @@ -558,6 +598,11 @@ public String getCheckoutAttemptId() { } + /** + * Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -585,6 +630,11 @@ public String getConversionId() { } + /** + * Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. + * + * @param conversionId + */ @Deprecated @JsonProperty(JSON_PROPERTY_CONVERSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -611,6 +661,11 @@ public String getCountryCode() { } + /** + * The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -636,6 +691,11 @@ public OffsetDateTime getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(OffsetDateTime dateOfBirth) { @@ -661,6 +721,11 @@ public OffsetDateTime getDeliverAt() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliverAt + */ @JsonProperty(JSON_PROPERTY_DELIVER_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliverAt(OffsetDateTime deliverAt) { @@ -686,6 +751,11 @@ public DeliveryAddress getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(DeliveryAddress deliveryAddress) { @@ -711,6 +781,11 @@ public String getDeviceFingerprint() { } + /** + * A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + * + * @param deviceFingerprint + */ @JsonProperty(JSON_PROPERTY_DEVICE_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceFingerprint(String deviceFingerprint) { @@ -727,7 +802,7 @@ public DonationPaymentRequest donationAccount(String donationAccount) { * Donation account to which the transaction is credited. * @return donationAccount **/ - @ApiModelProperty(required = true, value = "Donation account to which the transaction is credited.") + @ApiModelProperty(value = "Donation account to which the transaction is credited.") @JsonProperty(JSON_PROPERTY_DONATION_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -736,6 +811,11 @@ public String getDonationAccount() { } + /** + * Donation account to which the transaction is credited. + * + * @param donationAccount + */ @JsonProperty(JSON_PROPERTY_DONATION_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationAccount(String donationAccount) { @@ -761,6 +841,11 @@ public String getDonationOriginalPspReference() { } + /** + * PSP reference of the transaction from which the donation token is generated. Required when `donationToken` is provided. + * + * @param donationOriginalPspReference + */ @JsonProperty(JSON_PROPERTY_DONATION_ORIGINAL_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationOriginalPspReference(String donationOriginalPspReference) { @@ -786,6 +871,11 @@ public String getDonationToken() { } + /** + * Donation token received in the `/payments` call. + * + * @param donationToken + */ @JsonProperty(JSON_PROPERTY_DONATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationToken(String donationToken) { @@ -819,6 +909,11 @@ public List getLineItems() { } + /** + * Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -844,6 +939,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -869,6 +969,11 @@ public MerchantRiskIndicator getMerchantRiskIndicator() { } + /** + * merchantRiskIndicator + * + * @param merchantRiskIndicator + */ @JsonProperty(JSON_PROPERTY_MERCHANT_RISK_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) { @@ -902,6 +1007,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -927,6 +1037,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -952,6 +1067,11 @@ public String getOrigin() { } + /** + * Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from. + * + * @param origin + */ @JsonProperty(JSON_PROPERTY_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrigin(String origin) { @@ -977,6 +1097,11 @@ public DonationPaymentMethod getPaymentMethod() { } + /** + * paymentMethod + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(DonationPaymentMethod paymentMethod) { @@ -1002,6 +1127,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1027,6 +1157,11 @@ public String getRedirectFromIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting back from the issuer. + * + * @param redirectFromIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod) { @@ -1052,6 +1187,11 @@ public String getRedirectToIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting to the issuer. + * + * @param redirectToIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectToIssuerMethod(String redirectToIssuerMethod) { @@ -1077,6 +1217,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1102,6 +1247,11 @@ public String getReturnUrl() { } + /** + * The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -1127,6 +1277,11 @@ public String getSessionValidity() { } + /** + * The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00 + * + * @param sessionValidity + */ @JsonProperty(JSON_PROPERTY_SESSION_VALIDITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionValidity(String sessionValidity) { @@ -1152,6 +1307,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1177,6 +1337,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1202,6 +1367,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1227,6 +1397,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1252,6 +1427,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1277,6 +1457,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1302,6 +1487,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1327,6 +1517,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1352,6 +1547,11 @@ public ThreeDS2RequestFields getThreeDS2RequestData() { } + /** + * threeDS2RequestData + * + * @param threeDS2RequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData) { @@ -1379,6 +1579,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/src/main/java/com/adyen/model/checkout/DonationPaymentResponse.java b/src/main/java/com/adyen/model/checkout/DonationPaymentResponse.java index a82c2810a..753136232 100644 --- a/src/main/java/com/adyen/model/checkout/DonationPaymentResponse.java +++ b/src/main/java/com/adyen/model/checkout/DonationPaymentResponse.java @@ -122,6 +122,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -147,6 +152,11 @@ public String getDonationAccount() { } + /** + * The Adyen account name of your charity. We will provide you with this account name once your chosen charity has been [onboarded](https://docs.adyen.com/online-payments/donations#onboarding). + * + * @param donationAccount + */ @JsonProperty(JSON_PROPERTY_DONATION_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationAccount(String donationAccount) { @@ -172,6 +182,11 @@ public String getId() { } + /** + * Your unique resource identifier. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -197,6 +212,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -222,6 +242,11 @@ public PaymentResponse getPayment() { } + /** + * payment + * + * @param payment + */ @JsonProperty(JSON_PROPERTY_PAYMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayment(PaymentResponse payment) { @@ -247,6 +272,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -272,6 +302,11 @@ public StatusEnum getStatus() { } + /** + * The status of the donation transaction. Possible values: * **completed** * **pending** * **refused** + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/DotpayDetails.java b/src/main/java/com/adyen/model/checkout/DotpayDetails.java index 1ba568b04..d33fe6e09 100644 --- a/src/main/java/com/adyen/model/checkout/DotpayDetails.java +++ b/src/main/java/com/adyen/model/checkout/DotpayDetails.java @@ -100,6 +100,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -125,6 +130,11 @@ public String getIssuer() { } + /** + * The Dotpay issuer value of the shopper's selected bank. Set this to an **id** of a Dotpay issuer to preselect it. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **dotpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/DragonpayDetails.java b/src/main/java/com/adyen/model/checkout/DragonpayDetails.java index deb71210c..d5bf80d2d 100644 --- a/src/main/java/com/adyen/model/checkout/DragonpayDetails.java +++ b/src/main/java/com/adyen/model/checkout/DragonpayDetails.java @@ -110,6 +110,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -135,6 +140,11 @@ public String getIssuer() { } + /** + * The Dragonpay issuer value of the shopper's selected bank. Set this to an **id** of a Dragonpay issuer to preselect it. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -160,6 +170,11 @@ public String getShopperEmail() { } + /** + * The shopper’s email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -185,6 +200,11 @@ public TypeEnum getType() { } + /** + * **dragonpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/EcontextVoucherDetails.java b/src/main/java/com/adyen/model/checkout/EcontextVoucherDetails.java index fe60d7e07..10ea29223 100644 --- a/src/main/java/com/adyen/model/checkout/EcontextVoucherDetails.java +++ b/src/main/java/com/adyen/model/checkout/EcontextVoucherDetails.java @@ -114,6 +114,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -139,6 +144,11 @@ public String getFirstName() { } + /** + * The shopper's first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -164,6 +174,11 @@ public String getLastName() { } + /** + * The shopper's last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -189,6 +204,11 @@ public String getShopperEmail() { } + /** + * The shopper's email. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -214,6 +234,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's contact number. It must have an international number format, for example **+31 20 779 1846**. Formats like **+31 (0)20 779 1846** or **0031 20 779 1846** are not accepted. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -239,6 +264,11 @@ public TypeEnum getType() { } + /** + * **econtextvoucher** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/EncryptedOrderData.java b/src/main/java/com/adyen/model/checkout/EncryptedOrderData.java index 7303e1180..88ef34013 100644 --- a/src/main/java/com/adyen/model/checkout/EncryptedOrderData.java +++ b/src/main/java/com/adyen/model/checkout/EncryptedOrderData.java @@ -63,6 +63,11 @@ public String getOrderData() { } + /** + * The encrypted order data. + * + * @param orderData + */ @JsonProperty(JSON_PROPERTY_ORDER_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderData(String orderData) { @@ -88,6 +93,11 @@ public String getPspReference() { } + /** + * The `pspReference` that belongs to the order. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { diff --git a/src/main/java/com/adyen/model/checkout/ExternalPlatform.java b/src/main/java/com/adyen/model/checkout/ExternalPlatform.java index c211065b1..e70e20393 100644 --- a/src/main/java/com/adyen/model/checkout/ExternalPlatform.java +++ b/src/main/java/com/adyen/model/checkout/ExternalPlatform.java @@ -67,6 +67,11 @@ public String getIntegrator() { } + /** + * External platform integrator. + * + * @param integrator + */ @JsonProperty(JSON_PROPERTY_INTEGRATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIntegrator(String integrator) { @@ -92,6 +97,11 @@ public String getName() { } + /** + * Name of the field. For example, Name of External Platform. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -117,6 +127,11 @@ public String getVersion() { } + /** + * Version of the field. For example, Version of External Platform. + * + * @param version + */ @JsonProperty(JSON_PROPERTY_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersion(String version) { diff --git a/src/main/java/com/adyen/model/checkout/ForexQuote.java b/src/main/java/com/adyen/model/checkout/ForexQuote.java index 96a17b348..13a60c2b5 100644 --- a/src/main/java/com/adyen/model/checkout/ForexQuote.java +++ b/src/main/java/com/adyen/model/checkout/ForexQuote.java @@ -105,6 +105,11 @@ public String getAccount() { } + /** + * The account name. + * + * @param account + */ @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(String account) { @@ -130,6 +135,11 @@ public String getAccountType() { } + /** + * The account type. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(String accountType) { @@ -155,6 +165,11 @@ public Amount getBaseAmount() { } + /** + * baseAmount + * + * @param baseAmount + */ @JsonProperty(JSON_PROPERTY_BASE_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBaseAmount(Amount baseAmount) { @@ -180,6 +195,11 @@ public Integer getBasePoints() { } + /** + * The base points. + * + * @param basePoints + */ @JsonProperty(JSON_PROPERTY_BASE_POINTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBasePoints(Integer basePoints) { @@ -205,6 +225,11 @@ public Amount getBuy() { } + /** + * buy + * + * @param buy + */ @JsonProperty(JSON_PROPERTY_BUY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBuy(Amount buy) { @@ -230,6 +255,11 @@ public Amount getInterbank() { } + /** + * interbank + * + * @param interbank + */ @JsonProperty(JSON_PROPERTY_INTERBANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterbank(Amount interbank) { @@ -255,6 +285,11 @@ public String getReference() { } + /** + * The reference assigned to the forex quote request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -280,6 +315,11 @@ public Amount getSell() { } + /** + * sell + * + * @param sell + */ @JsonProperty(JSON_PROPERTY_SELL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSell(Amount sell) { @@ -305,6 +345,11 @@ public String getSignature() { } + /** + * The signature to validate the integrity. + * + * @param signature + */ @JsonProperty(JSON_PROPERTY_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignature(String signature) { @@ -330,6 +375,11 @@ public String getSource() { } + /** + * The source of the forex quote. + * + * @param source + */ @JsonProperty(JSON_PROPERTY_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSource(String source) { @@ -355,6 +405,11 @@ public String getType() { } + /** + * The type of forex. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -380,6 +435,11 @@ public OffsetDateTime getValidTill() { } + /** + * The date until which the forex quote is valid. + * + * @param validTill + */ @JsonProperty(JSON_PROPERTY_VALID_TILL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidTill(OffsetDateTime validTill) { diff --git a/src/main/java/com/adyen/model/checkout/FraudCheckResult.java b/src/main/java/com/adyen/model/checkout/FraudCheckResult.java index 825712071..ac9cf0148 100644 --- a/src/main/java/com/adyen/model/checkout/FraudCheckResult.java +++ b/src/main/java/com/adyen/model/checkout/FraudCheckResult.java @@ -67,6 +67,11 @@ public Integer getAccountScore() { } + /** + * The fraud score generated by the risk check. + * + * @param accountScore + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountScore(Integer accountScore) { @@ -92,6 +97,11 @@ public Integer getCheckId() { } + /** + * The ID of the risk check. + * + * @param checkId + */ @JsonProperty(JSON_PROPERTY_CHECK_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckId(Integer checkId) { @@ -117,6 +127,11 @@ public String getName() { } + /** + * The name of the risk check. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/checkout/FraudResult.java b/src/main/java/com/adyen/model/checkout/FraudResult.java index 98ac088bc..3b01d83bb 100644 --- a/src/main/java/com/adyen/model/checkout/FraudResult.java +++ b/src/main/java/com/adyen/model/checkout/FraudResult.java @@ -66,6 +66,11 @@ public Integer getAccountScore() { } + /** + * The total fraud score generated by the risk checks. + * + * @param accountScore + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountScore(Integer accountScore) { @@ -99,6 +104,11 @@ public List getResults() { } + /** + * The result of the individual risk checks. + * + * @param results + */ @JsonProperty(JSON_PROPERTY_RESULTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResults(List results) { diff --git a/src/main/java/com/adyen/model/checkout/FundOrigin.java b/src/main/java/com/adyen/model/checkout/FundOrigin.java index 664ec8cdb..fc9a918f9 100644 --- a/src/main/java/com/adyen/model/checkout/FundOrigin.java +++ b/src/main/java/com/adyen/model/checkout/FundOrigin.java @@ -34,16 +34,28 @@ */ @JsonPropertyOrder({ FundOrigin.JSON_PROPERTY_BILLING_ADDRESS, - FundOrigin.JSON_PROPERTY_SHOPPER_NAME + FundOrigin.JSON_PROPERTY_SHOPPER_EMAIL, + FundOrigin.JSON_PROPERTY_SHOPPER_NAME, + FundOrigin.JSON_PROPERTY_TELEPHONE_NUMBER, + FundOrigin.JSON_PROPERTY_WALLET_IDENTIFIER }) public class FundOrigin { public static final String JSON_PROPERTY_BILLING_ADDRESS = "billingAddress"; private Address billingAddress; + public static final String JSON_PROPERTY_SHOPPER_EMAIL = "shopperEmail"; + private String shopperEmail; + public static final String JSON_PROPERTY_SHOPPER_NAME = "shopperName"; private Name shopperName; + public static final String JSON_PROPERTY_TELEPHONE_NUMBER = "telephoneNumber"; + private String telephoneNumber; + + public static final String JSON_PROPERTY_WALLET_IDENTIFIER = "walletIdentifier"; + private String walletIdentifier; + public FundOrigin() { } @@ -65,6 +77,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -72,6 +89,36 @@ public void setBillingAddress(Address billingAddress) { } + public FundOrigin shopperEmail(String shopperEmail) { + this.shopperEmail = shopperEmail; + return this; + } + + /** + * Email address of the person. + * @return shopperEmail + **/ + @ApiModelProperty(value = "Email address of the person.") + @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getShopperEmail() { + return shopperEmail; + } + + + /** + * Email address of the person. + * + * @param shopperEmail + */ + @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setShopperEmail(String shopperEmail) { + this.shopperEmail = shopperEmail; + } + + public FundOrigin shopperName(Name shopperName) { this.shopperName = shopperName; return this; @@ -90,6 +137,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -97,6 +149,66 @@ public void setShopperName(Name shopperName) { } + public FundOrigin telephoneNumber(String telephoneNumber) { + this.telephoneNumber = telephoneNumber; + return this; + } + + /** + * Phone number of the person + * @return telephoneNumber + **/ + @ApiModelProperty(value = "Phone number of the person") + @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTelephoneNumber() { + return telephoneNumber; + } + + + /** + * Phone number of the person + * + * @param telephoneNumber + */ + @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTelephoneNumber(String telephoneNumber) { + this.telephoneNumber = telephoneNumber; + } + + + public FundOrigin walletIdentifier(String walletIdentifier) { + this.walletIdentifier = walletIdentifier; + return this; + } + + /** + * Get walletIdentifier + * @return walletIdentifier + **/ + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_WALLET_IDENTIFIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getWalletIdentifier() { + return walletIdentifier; + } + + + /** + * walletIdentifier + * + * @param walletIdentifier + */ + @JsonProperty(JSON_PROPERTY_WALLET_IDENTIFIER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setWalletIdentifier(String walletIdentifier) { + this.walletIdentifier = walletIdentifier; + } + + /** * Return true if this FundOrigin object is equal to o. */ @@ -110,12 +222,15 @@ public boolean equals(Object o) { } FundOrigin fundOrigin = (FundOrigin) o; return Objects.equals(this.billingAddress, fundOrigin.billingAddress) && - Objects.equals(this.shopperName, fundOrigin.shopperName); + Objects.equals(this.shopperEmail, fundOrigin.shopperEmail) && + Objects.equals(this.shopperName, fundOrigin.shopperName) && + Objects.equals(this.telephoneNumber, fundOrigin.telephoneNumber) && + Objects.equals(this.walletIdentifier, fundOrigin.walletIdentifier); } @Override public int hashCode() { - return Objects.hash(billingAddress, shopperName); + return Objects.hash(billingAddress, shopperEmail, shopperName, telephoneNumber, walletIdentifier); } @Override @@ -123,7 +238,10 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class FundOrigin {\n"); sb.append(" billingAddress: ").append(toIndentedString(billingAddress)).append("\n"); + sb.append(" shopperEmail: ").append(toIndentedString(shopperEmail)).append("\n"); sb.append(" shopperName: ").append(toIndentedString(shopperName)).append("\n"); + sb.append(" telephoneNumber: ").append(toIndentedString(telephoneNumber)).append("\n"); + sb.append(" walletIdentifier: ").append(toIndentedString(walletIdentifier)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/adyen/model/checkout/FundRecipient.java b/src/main/java/com/adyen/model/checkout/FundRecipient.java index 3d2a9e301..fed627b19 100644 --- a/src/main/java/com/adyen/model/checkout/FundRecipient.java +++ b/src/main/java/com/adyen/model/checkout/FundRecipient.java @@ -99,6 +99,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -124,6 +129,11 @@ public CardDetails getPaymentMethod() { } + /** + * paymentMethod + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(CardDetails paymentMethod) { @@ -149,6 +159,11 @@ public String getShopperEmail() { } + /** + * the email address of the person + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -174,6 +189,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -199,6 +219,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -224,6 +249,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -249,6 +279,11 @@ public SubMerchant getSubMerchant() { } + /** + * subMerchant + * + * @param subMerchant + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchant(SubMerchant subMerchant) { @@ -274,6 +309,11 @@ public String getTelephoneNumber() { } + /** + * the telephone number of the person + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -299,6 +339,11 @@ public String getWalletIdentifier() { } + /** + * indicates where the money is going + * + * @param walletIdentifier + */ @JsonProperty(JSON_PROPERTY_WALLET_IDENTIFIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWalletIdentifier(String walletIdentifier) { @@ -324,6 +369,11 @@ public String getWalletOwnerTaxId() { } + /** + * indicates the tax identifier of the fund recepient + * + * @param walletOwnerTaxId + */ @JsonProperty(JSON_PROPERTY_WALLET_OWNER_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWalletOwnerTaxId(String walletOwnerTaxId) { diff --git a/src/main/java/com/adyen/model/checkout/GenericIssuerPaymentMethodDetails.java b/src/main/java/com/adyen/model/checkout/GenericIssuerPaymentMethodDetails.java index 745d0e91b..843fa071d 100644 --- a/src/main/java/com/adyen/model/checkout/GenericIssuerPaymentMethodDetails.java +++ b/src/main/java/com/adyen/model/checkout/GenericIssuerPaymentMethodDetails.java @@ -114,6 +114,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -139,6 +144,11 @@ public String getIssuer() { } + /** + * The issuer id of the shopper's selected bank. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -166,6 +176,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -192,6 +207,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -217,6 +237,11 @@ public TypeEnum getType() { } + /** + * **genericissuer** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/GiropayDetails.java b/src/main/java/com/adyen/model/checkout/GiropayDetails.java index 72298ecc3..2dfa5a101 100644 --- a/src/main/java/com/adyen/model/checkout/GiropayDetails.java +++ b/src/main/java/com/adyen/model/checkout/GiropayDetails.java @@ -104,6 +104,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -131,6 +136,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -157,6 +167,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -182,6 +197,11 @@ public TypeEnum getType() { } + /** + * **giropay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/GooglePayDetails.java b/src/main/java/com/adyen/model/checkout/GooglePayDetails.java index 50d44d2bb..71d8956f0 100644 --- a/src/main/java/com/adyen/model/checkout/GooglePayDetails.java +++ b/src/main/java/com/adyen/model/checkout/GooglePayDetails.java @@ -33,6 +33,7 @@ @JsonPropertyOrder({ GooglePayDetails.JSON_PROPERTY_CHECKOUT_ATTEMPT_ID, GooglePayDetails.JSON_PROPERTY_FUNDING_SOURCE, + GooglePayDetails.JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK, GooglePayDetails.JSON_PROPERTY_GOOGLE_PAY_TOKEN, GooglePayDetails.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE, GooglePayDetails.JSON_PROPERTY_STORED_PAYMENT_METHOD_ID, @@ -81,6 +82,9 @@ public static FundingSourceEnum fromValue(String value) { public static final String JSON_PROPERTY_FUNDING_SOURCE = "fundingSource"; private FundingSourceEnum fundingSource; + public static final String JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK = "googlePayCardNetwork"; + private String googlePayCardNetwork; + public static final String JSON_PROPERTY_GOOGLE_PAY_TOKEN = "googlePayToken"; private String googlePayToken; @@ -147,6 +151,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -172,6 +181,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -179,6 +193,36 @@ public void setFundingSource(FundingSourceEnum fundingSource) { } + public GooglePayDetails googlePayCardNetwork(String googlePayCardNetwork) { + this.googlePayCardNetwork = googlePayCardNetwork; + return this; + } + + /** + * The selected payment card network. + * @return googlePayCardNetwork + **/ + @ApiModelProperty(value = "The selected payment card network. ") + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGooglePayCardNetwork() { + return googlePayCardNetwork; + } + + + /** + * The selected payment card network. + * + * @param googlePayCardNetwork + */ + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGooglePayCardNetwork(String googlePayCardNetwork) { + this.googlePayCardNetwork = googlePayCardNetwork; + } + + public GooglePayDetails googlePayToken(String googlePayToken) { this.googlePayToken = googlePayToken; return this; @@ -197,6 +241,11 @@ public String getGooglePayToken() { } + /** + * The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. + * + * @param googlePayToken + */ @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGooglePayToken(String googlePayToken) { @@ -224,6 +273,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -250,6 +304,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -275,6 +334,11 @@ public TypeEnum getType() { } + /** + * **googlepay**, **paywithgoogle** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -296,6 +360,7 @@ public boolean equals(Object o) { GooglePayDetails googlePayDetails = (GooglePayDetails) o; return Objects.equals(this.checkoutAttemptId, googlePayDetails.checkoutAttemptId) && Objects.equals(this.fundingSource, googlePayDetails.fundingSource) && + Objects.equals(this.googlePayCardNetwork, googlePayDetails.googlePayCardNetwork) && Objects.equals(this.googlePayToken, googlePayDetails.googlePayToken) && Objects.equals(this.recurringDetailReference, googlePayDetails.recurringDetailReference) && Objects.equals(this.storedPaymentMethodId, googlePayDetails.storedPaymentMethodId) && @@ -304,7 +369,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(checkoutAttemptId, fundingSource, googlePayToken, recurringDetailReference, storedPaymentMethodId, type); + return Objects.hash(checkoutAttemptId, fundingSource, googlePayCardNetwork, googlePayToken, recurringDetailReference, storedPaymentMethodId, type); } @Override @@ -313,6 +378,7 @@ public String toString() { sb.append("class GooglePayDetails {\n"); sb.append(" checkoutAttemptId: ").append(toIndentedString(checkoutAttemptId)).append("\n"); sb.append(" fundingSource: ").append(toIndentedString(fundingSource)).append("\n"); + sb.append(" googlePayCardNetwork: ").append(toIndentedString(googlePayCardNetwork)).append("\n"); sb.append(" googlePayToken: ").append(toIndentedString(googlePayToken)).append("\n"); sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n"); sb.append(" storedPaymentMethodId: ").append(toIndentedString(storedPaymentMethodId)).append("\n"); diff --git a/src/main/java/com/adyen/model/checkout/GooglePayDonations.java b/src/main/java/com/adyen/model/checkout/GooglePayDonations.java new file mode 100644 index 000000000..c2e390cf3 --- /dev/null +++ b/src/main/java/com/adyen/model/checkout/GooglePayDonations.java @@ -0,0 +1,420 @@ +/* + * Adyen Checkout API + * + * The version of the OpenAPI document: 71 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.checkout; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * GooglePayDonations + */ +@JsonPropertyOrder({ + GooglePayDonations.JSON_PROPERTY_CHECKOUT_ATTEMPT_ID, + GooglePayDonations.JSON_PROPERTY_FUNDING_SOURCE, + GooglePayDonations.JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK, + GooglePayDonations.JSON_PROPERTY_GOOGLE_PAY_TOKEN, + GooglePayDonations.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE, + GooglePayDonations.JSON_PROPERTY_STORED_PAYMENT_METHOD_ID, + GooglePayDonations.JSON_PROPERTY_TYPE +}) + +public class GooglePayDonations { + public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID = "checkoutAttemptId"; + private String checkoutAttemptId; + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + */ + public enum FundingSourceEnum { + CREDIT("credit"), + + DEBIT("debit"); + + private String value; + + FundingSourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FundingSourceEnum fromValue(String value) { + for (FundingSourceEnum b : FundingSourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FUNDING_SOURCE = "fundingSource"; + private FundingSourceEnum fundingSource; + + public static final String JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK = "googlePayCardNetwork"; + private String googlePayCardNetwork; + + public static final String JSON_PROPERTY_GOOGLE_PAY_TOKEN = "googlePayToken"; + private String googlePayToken; + + public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE = "recurringDetailReference"; + private String recurringDetailReference; + + public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID = "storedPaymentMethodId"; + private String storedPaymentMethodId; + + /** + * **googlepay**, **paywithgoogle** + */ + public enum TypeEnum { + GOOGLEPAY("googlepay"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TypeEnum fromValue(String value) { + for (TypeEnum b : TypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TYPE = "type"; + private TypeEnum type = TypeEnum.GOOGLEPAY; + + public GooglePayDonations() { + } + + public GooglePayDonations checkoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + return this; + } + + /** + * The checkout attempt identifier. + * @return checkoutAttemptId + **/ + @ApiModelProperty(value = "The checkout attempt identifier.") + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCheckoutAttemptId() { + return checkoutAttemptId; + } + + + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCheckoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + } + + + public GooglePayDonations fundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + return this; + } + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * @return fundingSource + **/ + @ApiModelProperty(value = "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.") + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FundingSourceEnum getFundingSource() { + return fundingSource; + } + + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + } + + + public GooglePayDonations googlePayCardNetwork(String googlePayCardNetwork) { + this.googlePayCardNetwork = googlePayCardNetwork; + return this; + } + + /** + * The selected payment card network. + * @return googlePayCardNetwork + **/ + @ApiModelProperty(value = "The selected payment card network. ") + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGooglePayCardNetwork() { + return googlePayCardNetwork; + } + + + /** + * The selected payment card network. + * + * @param googlePayCardNetwork + */ + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_CARD_NETWORK) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGooglePayCardNetwork(String googlePayCardNetwork) { + this.googlePayCardNetwork = googlePayCardNetwork; + } + + + public GooglePayDonations googlePayToken(String googlePayToken) { + this.googlePayToken = googlePayToken; + return this; + } + + /** + * The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. + * @return googlePayToken + **/ + @ApiModelProperty(required = true, value = "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.") + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_TOKEN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGooglePayToken() { + return googlePayToken; + } + + + /** + * The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. + * + * @param googlePayToken + */ + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_TOKEN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGooglePayToken(String googlePayToken) { + this.googlePayToken = googlePayToken; + } + + + public GooglePayDonations recurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return recurringDetailReference + * @deprecated + **/ + @Deprecated + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getRecurringDetailReference() { + return recurringDetailReference; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ + @Deprecated + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setRecurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + } + + + public GooglePayDonations storedPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return storedPaymentMethodId + **/ + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStoredPaymentMethodId() { + return storedPaymentMethodId; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setStoredPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + } + + + public GooglePayDonations type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * **googlepay**, **paywithgoogle** + * @return type + **/ + @ApiModelProperty(value = "**googlepay**, **paywithgoogle**") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TypeEnum getType() { + return type; + } + + + /** + * **googlepay**, **paywithgoogle** + * + * @param type + */ + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(TypeEnum type) { + this.type = type; + } + + + /** + * Return true if this GooglePayDonations object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + GooglePayDonations googlePayDonations = (GooglePayDonations) o; + return Objects.equals(this.checkoutAttemptId, googlePayDonations.checkoutAttemptId) && + Objects.equals(this.fundingSource, googlePayDonations.fundingSource) && + Objects.equals(this.googlePayCardNetwork, googlePayDonations.googlePayCardNetwork) && + Objects.equals(this.googlePayToken, googlePayDonations.googlePayToken) && + Objects.equals(this.recurringDetailReference, googlePayDonations.recurringDetailReference) && + Objects.equals(this.storedPaymentMethodId, googlePayDonations.storedPaymentMethodId) && + Objects.equals(this.type, googlePayDonations.type); + } + + @Override + public int hashCode() { + return Objects.hash(checkoutAttemptId, fundingSource, googlePayCardNetwork, googlePayToken, recurringDetailReference, storedPaymentMethodId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class GooglePayDonations {\n"); + sb.append(" checkoutAttemptId: ").append(toIndentedString(checkoutAttemptId)).append("\n"); + sb.append(" fundingSource: ").append(toIndentedString(fundingSource)).append("\n"); + sb.append(" googlePayCardNetwork: ").append(toIndentedString(googlePayCardNetwork)).append("\n"); + sb.append(" googlePayToken: ").append(toIndentedString(googlePayToken)).append("\n"); + sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n"); + sb.append(" storedPaymentMethodId: ").append(toIndentedString(storedPaymentMethodId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of GooglePayDonations given an JSON string + * + * @param jsonString JSON string + * @return An instance of GooglePayDonations + * @throws JsonProcessingException if the JSON string is invalid with respect to GooglePayDonations + */ + public static GooglePayDonations fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, GooglePayDonations.class); + } +/** + * Convert an instance of GooglePayDonations to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/checkout/IdealDetails.java b/src/main/java/com/adyen/model/checkout/IdealDetails.java index 20c17b183..5965ee0c9 100644 --- a/src/main/java/com/adyen/model/checkout/IdealDetails.java +++ b/src/main/java/com/adyen/model/checkout/IdealDetails.java @@ -108,6 +108,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -133,6 +138,11 @@ public String getIssuer() { } + /** + * The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -160,6 +170,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -186,6 +201,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -211,6 +231,11 @@ public TypeEnum getType() { } + /** + * **ideal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/IdealDonations.java b/src/main/java/com/adyen/model/checkout/IdealDonations.java new file mode 100644 index 000000000..3fb4b2291 --- /dev/null +++ b/src/main/java/com/adyen/model/checkout/IdealDonations.java @@ -0,0 +1,313 @@ +/* + * Adyen Checkout API + * + * The version of the OpenAPI document: 71 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.checkout; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * IdealDonations + */ +@JsonPropertyOrder({ + IdealDonations.JSON_PROPERTY_CHECKOUT_ATTEMPT_ID, + IdealDonations.JSON_PROPERTY_ISSUER, + IdealDonations.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE, + IdealDonations.JSON_PROPERTY_STORED_PAYMENT_METHOD_ID, + IdealDonations.JSON_PROPERTY_TYPE +}) + +public class IdealDonations { + public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID = "checkoutAttemptId"; + private String checkoutAttemptId; + + public static final String JSON_PROPERTY_ISSUER = "issuer"; + private String issuer; + + public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE = "recurringDetailReference"; + private String recurringDetailReference; + + public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID = "storedPaymentMethodId"; + private String storedPaymentMethodId; + + /** + * **ideal** + */ + public enum TypeEnum { + IDEAL("ideal"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TypeEnum fromValue(String value) { + for (TypeEnum b : TypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TYPE = "type"; + private TypeEnum type = TypeEnum.IDEAL; + + public IdealDonations() { + } + + public IdealDonations checkoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + return this; + } + + /** + * The checkout attempt identifier. + * @return checkoutAttemptId + **/ + @ApiModelProperty(value = "The checkout attempt identifier.") + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCheckoutAttemptId() { + return checkoutAttemptId; + } + + + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCheckoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + } + + + public IdealDonations issuer(String issuer) { + this.issuer = issuer; + return this; + } + + /** + * The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. + * @return issuer + **/ + @ApiModelProperty(required = true, value = "The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it.") + @JsonProperty(JSON_PROPERTY_ISSUER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getIssuer() { + return issuer; + } + + + /** + * The iDEAL issuer value of the shopper's selected bank. Set this to an **id** of an iDEAL issuer to preselect it. + * + * @param issuer + */ + @JsonProperty(JSON_PROPERTY_ISSUER) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIssuer(String issuer) { + this.issuer = issuer; + } + + + public IdealDonations recurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return recurringDetailReference + * @deprecated + **/ + @Deprecated + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getRecurringDetailReference() { + return recurringDetailReference; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ + @Deprecated + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setRecurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + } + + + public IdealDonations storedPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return storedPaymentMethodId + **/ + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStoredPaymentMethodId() { + return storedPaymentMethodId; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setStoredPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + } + + + public IdealDonations type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * **ideal** + * @return type + **/ + @ApiModelProperty(value = "**ideal**") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TypeEnum getType() { + return type; + } + + + /** + * **ideal** + * + * @param type + */ + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(TypeEnum type) { + this.type = type; + } + + + /** + * Return true if this IdealDonations object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + IdealDonations idealDonations = (IdealDonations) o; + return Objects.equals(this.checkoutAttemptId, idealDonations.checkoutAttemptId) && + Objects.equals(this.issuer, idealDonations.issuer) && + Objects.equals(this.recurringDetailReference, idealDonations.recurringDetailReference) && + Objects.equals(this.storedPaymentMethodId, idealDonations.storedPaymentMethodId) && + Objects.equals(this.type, idealDonations.type); + } + + @Override + public int hashCode() { + return Objects.hash(checkoutAttemptId, issuer, recurringDetailReference, storedPaymentMethodId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class IdealDonations {\n"); + sb.append(" checkoutAttemptId: ").append(toIndentedString(checkoutAttemptId)).append("\n"); + sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n"); + sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n"); + sb.append(" storedPaymentMethodId: ").append(toIndentedString(storedPaymentMethodId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of IdealDonations given an JSON string + * + * @param jsonString JSON string + * @return An instance of IdealDonations + * @throws JsonProcessingException if the JSON string is invalid with respect to IdealDonations + */ + public static IdealDonations fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, IdealDonations.class); + } +/** + * Convert an instance of IdealDonations to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/checkout/InputDetail.java b/src/main/java/com/adyen/model/checkout/InputDetail.java index 2939545cd..b3e705eb5 100644 --- a/src/main/java/com/adyen/model/checkout/InputDetail.java +++ b/src/main/java/com/adyen/model/checkout/InputDetail.java @@ -105,6 +105,11 @@ public Map getConfiguration() { } + /** + * Configuration parameters for the required input. + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(Map configuration) { @@ -138,6 +143,11 @@ public List getDetails() { } + /** + * Input details can also be provided recursively. + * + * @param details + */ @JsonProperty(JSON_PROPERTY_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetails(List details) { @@ -173,6 +183,11 @@ public List getInputDetails() { } + /** + * Input details can also be provided recursively (deprecated). + * + * @param inputDetails + */ @Deprecated @JsonProperty(JSON_PROPERTY_INPUT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -199,6 +214,11 @@ public String getItemSearchUrl() { } + /** + * In case of a select, the URL from which to query the items. + * + * @param itemSearchUrl + */ @JsonProperty(JSON_PROPERTY_ITEM_SEARCH_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemSearchUrl(String itemSearchUrl) { @@ -232,6 +252,11 @@ public List getItems() { } + /** + * In case of a select, the items to choose from. + * + * @param items + */ @JsonProperty(JSON_PROPERTY_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItems(List items) { @@ -257,6 +282,11 @@ public String getKey() { } + /** + * The value to provide in the result. + * + * @param key + */ @JsonProperty(JSON_PROPERTY_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setKey(String key) { @@ -282,6 +312,11 @@ public Boolean getOptional() { } + /** + * True if this input value is optional. + * + * @param optional + */ @JsonProperty(JSON_PROPERTY_OPTIONAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptional(Boolean optional) { @@ -307,6 +342,11 @@ public String getType() { } + /** + * The type of the required input. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -332,6 +372,11 @@ public String getValue() { } + /** + * The value can be pre-filled, if available. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(String value) { diff --git a/src/main/java/com/adyen/model/checkout/InstallmentOption.java b/src/main/java/com/adyen/model/checkout/InstallmentOption.java index a516d3769..cb5780c72 100644 --- a/src/main/java/com/adyen/model/checkout/InstallmentOption.java +++ b/src/main/java/com/adyen/model/checkout/InstallmentOption.java @@ -108,6 +108,11 @@ public Integer getMaxValue() { } + /** + * The maximum number of installments offered for this payment method. + * + * @param maxValue + */ @JsonProperty(JSON_PROPERTY_MAX_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxValue(Integer maxValue) { @@ -141,6 +146,11 @@ public List getPlans() { } + /** + * Defines the type of installment plan. If not set, defaults to **regular**. Possible values: * **regular** * **revolving** + * + * @param plans + */ @JsonProperty(JSON_PROPERTY_PLANS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlans(List plans) { @@ -166,6 +176,11 @@ public Integer getPreselectedValue() { } + /** + * Preselected number of installments offered for this payment method. + * + * @param preselectedValue + */ @JsonProperty(JSON_PROPERTY_PRESELECTED_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreselectedValue(Integer preselectedValue) { @@ -199,6 +214,11 @@ public List getValues() { } + /** + * An array of the number of installments that the shopper can choose from. For example, **[2,3,5]**. This cannot be specified simultaneously with `maxValue`. + * + * @param values + */ @JsonProperty(JSON_PROPERTY_VALUES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValues(List values) { diff --git a/src/main/java/com/adyen/model/checkout/Installments.java b/src/main/java/com/adyen/model/checkout/Installments.java index dc22773bd..3f8cf2d74 100644 --- a/src/main/java/com/adyen/model/checkout/Installments.java +++ b/src/main/java/com/adyen/model/checkout/Installments.java @@ -98,6 +98,11 @@ public PlanEnum getPlan() { } + /** + * The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values: * **regular** * **revolving** + * + * @param plan + */ @JsonProperty(JSON_PROPERTY_PLAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlan(PlanEnum plan) { @@ -123,6 +128,11 @@ public Integer getValue() { } + /** + * Defines the number of installments. Its value needs to be greater than zero. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Integer value) { diff --git a/src/main/java/com/adyen/model/checkout/InstallmentsNumber.java b/src/main/java/com/adyen/model/checkout/InstallmentsNumber.java index 0f6373c10..8780d601d 100644 --- a/src/main/java/com/adyen/model/checkout/InstallmentsNumber.java +++ b/src/main/java/com/adyen/model/checkout/InstallmentsNumber.java @@ -59,6 +59,11 @@ public Integer getMaxNumberOfInstallments() { } + /** + * Maximum number of installments + * + * @param maxNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_MAX_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxNumberOfInstallments(Integer maxNumberOfInstallments) { diff --git a/src/main/java/com/adyen/model/checkout/Item.java b/src/main/java/com/adyen/model/checkout/Item.java index cb3c3a108..be910d686 100644 --- a/src/main/java/com/adyen/model/checkout/Item.java +++ b/src/main/java/com/adyen/model/checkout/Item.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * The value to provide in the result. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getName() { } + /** + * The display name. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/checkout/KlarnaDetails.java b/src/main/java/com/adyen/model/checkout/KlarnaDetails.java index f94bf2610..3de627de6 100644 --- a/src/main/java/com/adyen/model/checkout/KlarnaDetails.java +++ b/src/main/java/com/adyen/model/checkout/KlarnaDetails.java @@ -132,6 +132,11 @@ public String getBillingAddress() { } + /** + * The address where to send the invoice. + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(String billingAddress) { @@ -157,6 +162,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -182,6 +192,11 @@ public String getDeliveryAddress() { } + /** + * The address where the goods should be delivered. + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(String deliveryAddress) { @@ -207,6 +222,11 @@ public String getPersonalDetails() { } + /** + * Shopper name, date of birth, phone number, and email address. + * + * @param personalDetails + */ @JsonProperty(JSON_PROPERTY_PERSONAL_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPersonalDetails(String personalDetails) { @@ -234,6 +254,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -260,6 +285,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -285,6 +315,11 @@ public String getSubtype() { } + /** + * The type of flow to initiate. + * + * @param subtype + */ @JsonProperty(JSON_PROPERTY_SUBTYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubtype(String subtype) { @@ -310,6 +345,11 @@ public TypeEnum getType() { } + /** + * **klarna** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/LineItem.java b/src/main/java/com/adyen/model/checkout/LineItem.java index ce26e59ab..0ddbf5896 100644 --- a/src/main/java/com/adyen/model/checkout/LineItem.java +++ b/src/main/java/com/adyen/model/checkout/LineItem.java @@ -123,6 +123,11 @@ public Long getAmountExcludingTax() { } + /** + * Item amount excluding the tax, in minor units. + * + * @param amountExcludingTax + */ @JsonProperty(JSON_PROPERTY_AMOUNT_EXCLUDING_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountExcludingTax(Long amountExcludingTax) { @@ -148,6 +153,11 @@ public Long getAmountIncludingTax() { } + /** + * Item amount including the tax, in minor units. + * + * @param amountIncludingTax + */ @JsonProperty(JSON_PROPERTY_AMOUNT_INCLUDING_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountIncludingTax(Long amountIncludingTax) { @@ -173,6 +183,11 @@ public String getBrand() { } + /** + * Brand of the item. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -198,6 +213,11 @@ public String getColor() { } + /** + * Color of the item. + * + * @param color + */ @JsonProperty(JSON_PROPERTY_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setColor(String color) { @@ -223,6 +243,11 @@ public String getDescription() { } + /** + * Description of the line item. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -248,6 +273,11 @@ public String getId() { } + /** + * ID of the line item. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -273,6 +303,11 @@ public String getImageUrl() { } + /** + * Link to the picture of the purchased item. + * + * @param imageUrl + */ @JsonProperty(JSON_PROPERTY_IMAGE_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setImageUrl(String imageUrl) { @@ -298,6 +333,11 @@ public String getItemCategory() { } + /** + * Item category, used by the payment methods PayPal and Ratepay. + * + * @param itemCategory + */ @JsonProperty(JSON_PROPERTY_ITEM_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemCategory(String itemCategory) { @@ -323,6 +363,11 @@ public String getManufacturer() { } + /** + * Manufacturer of the item. + * + * @param manufacturer + */ @JsonProperty(JSON_PROPERTY_MANUFACTURER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setManufacturer(String manufacturer) { @@ -348,6 +393,11 @@ public String getProductUrl() { } + /** + * Link to the purchased item. + * + * @param productUrl + */ @JsonProperty(JSON_PROPERTY_PRODUCT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProductUrl(String productUrl) { @@ -373,6 +423,11 @@ public Long getQuantity() { } + /** + * Number of items. + * + * @param quantity + */ @JsonProperty(JSON_PROPERTY_QUANTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQuantity(Long quantity) { @@ -398,6 +453,11 @@ public String getReceiverEmail() { } + /** + * Email associated with the given product in the basket (usually in electronic gift cards). + * + * @param receiverEmail + */ @JsonProperty(JSON_PROPERTY_RECEIVER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceiverEmail(String receiverEmail) { @@ -423,6 +483,11 @@ public String getSize() { } + /** + * Size of the item. + * + * @param size + */ @JsonProperty(JSON_PROPERTY_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSize(String size) { @@ -448,6 +513,11 @@ public String getSku() { } + /** + * Stock keeping unit. + * + * @param sku + */ @JsonProperty(JSON_PROPERTY_SKU) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSku(String sku) { @@ -473,6 +543,11 @@ public Long getTaxAmount() { } + /** + * Tax amount, in minor units. + * + * @param taxAmount + */ @JsonProperty(JSON_PROPERTY_TAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxAmount(Long taxAmount) { @@ -498,6 +573,11 @@ public Long getTaxPercentage() { } + /** + * Tax percentage, in minor units. + * + * @param taxPercentage + */ @JsonProperty(JSON_PROPERTY_TAX_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxPercentage(Long taxPercentage) { @@ -523,6 +603,11 @@ public String getUpc() { } + /** + * Universal Product Code. + * + * @param upc + */ @JsonProperty(JSON_PROPERTY_UPC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpc(String upc) { diff --git a/src/main/java/com/adyen/model/checkout/ListStoredPaymentMethodsResponse.java b/src/main/java/com/adyen/model/checkout/ListStoredPaymentMethodsResponse.java index 5c617e9ba..84862e1bd 100644 --- a/src/main/java/com/adyen/model/checkout/ListStoredPaymentMethodsResponse.java +++ b/src/main/java/com/adyen/model/checkout/ListStoredPaymentMethodsResponse.java @@ -70,6 +70,11 @@ public String getMerchantAccount() { } + /** + * Your merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -95,6 +100,11 @@ public String getShopperReference() { } + /** + * Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -128,6 +138,11 @@ public List getStoredPaymentMethods() { } + /** + * List of all stored payment methods. + * + * @param storedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethods(List storedPaymentMethods) { diff --git a/src/main/java/com/adyen/model/checkout/Mandate.java b/src/main/java/com/adyen/model/checkout/Mandate.java index e9afbec7b..4eea58173 100644 --- a/src/main/java/com/adyen/model/checkout/Mandate.java +++ b/src/main/java/com/adyen/model/checkout/Mandate.java @@ -206,6 +206,11 @@ public String getAmount() { } + /** + * The billing amount (in minor units) of the recurring transactions. + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(String amount) { @@ -231,6 +236,11 @@ public AmountRuleEnum getAmountRule() { } + /** + * The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`. + * + * @param amountRule + */ @JsonProperty(JSON_PROPERTY_AMOUNT_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountRule(AmountRuleEnum amountRule) { @@ -256,6 +266,11 @@ public BillingAttemptsRuleEnum getBillingAttemptsRule() { } + /** + * The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date. + * + * @param billingAttemptsRule + */ @JsonProperty(JSON_PROPERTY_BILLING_ATTEMPTS_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAttemptsRule(BillingAttemptsRuleEnum billingAttemptsRule) { @@ -281,6 +296,11 @@ public String getBillingDay() { } + /** + * The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`. + * + * @param billingDay + */ @JsonProperty(JSON_PROPERTY_BILLING_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingDay(String billingDay) { @@ -306,6 +326,11 @@ public String getEndsAt() { } + /** + * End date of the billing plan, in YYYY-MM-DD format. + * + * @param endsAt + */ @JsonProperty(JSON_PROPERTY_ENDS_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEndsAt(String endsAt) { @@ -331,6 +356,11 @@ public FrequencyEnum getFrequency() { } + /** + * The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**. + * + * @param frequency + */ @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFrequency(FrequencyEnum frequency) { @@ -356,6 +386,11 @@ public String getRemarks() { } + /** + * The message shown by UPI to the shopper on the approval screen. + * + * @param remarks + */ @JsonProperty(JSON_PROPERTY_REMARKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemarks(String remarks) { @@ -381,6 +416,11 @@ public String getStartsAt() { } + /** + * Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. + * + * @param startsAt + */ @JsonProperty(JSON_PROPERTY_STARTS_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartsAt(String startsAt) { diff --git a/src/main/java/com/adyen/model/checkout/MasterpassDetails.java b/src/main/java/com/adyen/model/checkout/MasterpassDetails.java index bd273ef38..99ba3e018 100644 --- a/src/main/java/com/adyen/model/checkout/MasterpassDetails.java +++ b/src/main/java/com/adyen/model/checkout/MasterpassDetails.java @@ -139,6 +139,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -164,6 +169,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -189,6 +199,11 @@ public String getMasterpassTransactionId() { } + /** + * The Masterpass transaction ID. + * + * @param masterpassTransactionId + */ @JsonProperty(JSON_PROPERTY_MASTERPASS_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMasterpassTransactionId(String masterpassTransactionId) { @@ -214,6 +229,11 @@ public TypeEnum getType() { } + /** + * **masterpass** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/MbwayDetails.java b/src/main/java/com/adyen/model/checkout/MbwayDetails.java index 6a546ffe6..371c5e661 100644 --- a/src/main/java/com/adyen/model/checkout/MbwayDetails.java +++ b/src/main/java/com/adyen/model/checkout/MbwayDetails.java @@ -104,6 +104,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -129,6 +134,11 @@ public String getShopperEmail() { } + /** + * + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -154,6 +164,11 @@ public String getTelephoneNumber() { } + /** + * + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **mbway** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/MerchantDevice.java b/src/main/java/com/adyen/model/checkout/MerchantDevice.java index 7725083e9..e0933f2af 100644 --- a/src/main/java/com/adyen/model/checkout/MerchantDevice.java +++ b/src/main/java/com/adyen/model/checkout/MerchantDevice.java @@ -67,6 +67,11 @@ public String getOs() { } + /** + * Operating system running on the merchant device. + * + * @param os + */ @JsonProperty(JSON_PROPERTY_OS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOs(String os) { @@ -92,6 +97,11 @@ public String getOsVersion() { } + /** + * Version of the operating system on the merchant device. + * + * @param osVersion + */ @JsonProperty(JSON_PROPERTY_OS_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOsVersion(String osVersion) { @@ -117,6 +127,11 @@ public String getReference() { } + /** + * Merchant device reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/checkout/MerchantRiskIndicator.java b/src/main/java/com/adyen/model/checkout/MerchantRiskIndicator.java index a48cc1d52..a9951fa19 100644 --- a/src/main/java/com/adyen/model/checkout/MerchantRiskIndicator.java +++ b/src/main/java/com/adyen/model/checkout/MerchantRiskIndicator.java @@ -197,6 +197,11 @@ public Boolean getAddressMatch() { } + /** + * Whether the chosen delivery address is identical to the billing address. + * + * @param addressMatch + */ @JsonProperty(JSON_PROPERTY_ADDRESS_MATCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddressMatch(Boolean addressMatch) { @@ -222,6 +227,11 @@ public DeliveryAddressIndicatorEnum getDeliveryAddressIndicator() { } + /** + * Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other` + * + * @param deliveryAddressIndicator + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddressIndicator(DeliveryAddressIndicatorEnum deliveryAddressIndicator) { @@ -249,6 +259,11 @@ public String getDeliveryEmail() { } + /** + * The delivery email address (for digital goods). + * + * @param deliveryEmail + */ @Deprecated @JsonProperty(JSON_PROPERTY_DELIVERY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -275,6 +290,11 @@ public String getDeliveryEmailAddress() { } + /** + * For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters. + * + * @param deliveryEmailAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryEmailAddress(String deliveryEmailAddress) { @@ -300,6 +320,11 @@ public DeliveryTimeframeEnum getDeliveryTimeframe() { } + /** + * The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` + * + * @param deliveryTimeframe + */ @JsonProperty(JSON_PROPERTY_DELIVERY_TIMEFRAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryTimeframe(DeliveryTimeframeEnum deliveryTimeframe) { @@ -325,6 +350,11 @@ public Amount getGiftCardAmount() { } + /** + * giftCardAmount + * + * @param giftCardAmount + */ @JsonProperty(JSON_PROPERTY_GIFT_CARD_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiftCardAmount(Amount giftCardAmount) { @@ -350,6 +380,11 @@ public Integer getGiftCardCount() { } + /** + * For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. + * + * @param giftCardCount + */ @JsonProperty(JSON_PROPERTY_GIFT_CARD_COUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiftCardCount(Integer giftCardCount) { @@ -375,6 +410,11 @@ public String getGiftCardCurr() { } + /** + * For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. + * + * @param giftCardCurr + */ @JsonProperty(JSON_PROPERTY_GIFT_CARD_CURR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiftCardCurr(String giftCardCurr) { @@ -400,6 +440,11 @@ public OffsetDateTime getPreOrderDate() { } + /** + * For pre-order purchases, the expected date this product will be available to the shopper. + * + * @param preOrderDate + */ @JsonProperty(JSON_PROPERTY_PRE_ORDER_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreOrderDate(OffsetDateTime preOrderDate) { @@ -425,6 +470,11 @@ public Boolean getPreOrderPurchase() { } + /** + * Indicator for whether this transaction is for pre-ordering a product. + * + * @param preOrderPurchase + */ @JsonProperty(JSON_PROPERTY_PRE_ORDER_PURCHASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreOrderPurchase(Boolean preOrderPurchase) { @@ -450,6 +500,11 @@ public String getPreOrderPurchaseInd() { } + /** + * Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. + * + * @param preOrderPurchaseInd + */ @JsonProperty(JSON_PROPERTY_PRE_ORDER_PURCHASE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreOrderPurchaseInd(String preOrderPurchaseInd) { @@ -475,6 +530,11 @@ public Boolean getReorderItems() { } + /** + * Indicator for whether the shopper has already purchased the same items in the past. + * + * @param reorderItems + */ @JsonProperty(JSON_PROPERTY_REORDER_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReorderItems(Boolean reorderItems) { @@ -500,6 +560,11 @@ public String getReorderItemsInd() { } + /** + * Indicates whether the cardholder is reordering previously purchased merchandise. + * + * @param reorderItemsInd + */ @JsonProperty(JSON_PROPERTY_REORDER_ITEMS_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReorderItemsInd(String reorderItemsInd) { @@ -525,6 +590,11 @@ public String getShipIndicator() { } + /** + * Indicates shipping method chosen for the transaction. + * + * @param shipIndicator + */ @JsonProperty(JSON_PROPERTY_SHIP_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipIndicator(String shipIndicator) { diff --git a/src/main/java/com/adyen/model/checkout/MobilePayDetails.java b/src/main/java/com/adyen/model/checkout/MobilePayDetails.java index 43cb2f324..d38e6869d 100644 --- a/src/main/java/com/adyen/model/checkout/MobilePayDetails.java +++ b/src/main/java/com/adyen/model/checkout/MobilePayDetails.java @@ -96,6 +96,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **mobilepay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/ModelConfiguration.java b/src/main/java/com/adyen/model/checkout/ModelConfiguration.java index 3f0b76aae..2965f7f59 100644 --- a/src/main/java/com/adyen/model/checkout/ModelConfiguration.java +++ b/src/main/java/com/adyen/model/checkout/ModelConfiguration.java @@ -112,6 +112,11 @@ public Avs getAvs() { } + /** + * avs + * + * @param avs + */ @JsonProperty(JSON_PROPERTY_AVS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvs(Avs avs) { @@ -137,6 +142,11 @@ public CardHolderNameEnum getCardHolderName() { } + /** + * Determines whether the cardholder name should be provided or not. Permitted values: * NONE * OPTIONAL * REQUIRED + * + * @param cardHolderName + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderName(CardHolderNameEnum cardHolderName) { @@ -162,6 +172,11 @@ public InstallmentsNumber getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(InstallmentsNumber installments) { @@ -187,6 +202,11 @@ public ShopperInput getShopperInput() { } + /** + * shopperInput + * + * @param shopperInput + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INPUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInput(ShopperInput shopperInput) { diff --git a/src/main/java/com/adyen/model/checkout/MolPayDetails.java b/src/main/java/com/adyen/model/checkout/MolPayDetails.java index 9b681c009..2f5a2be4f 100644 --- a/src/main/java/com/adyen/model/checkout/MolPayDetails.java +++ b/src/main/java/com/adyen/model/checkout/MolPayDetails.java @@ -102,6 +102,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -127,6 +132,11 @@ public String getIssuer() { } + /** + * The shopper's bank. Specify this with the issuer value that corresponds to this bank. + * + * @param issuer + */ @JsonProperty(JSON_PROPERTY_ISSUER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuer(String issuer) { @@ -152,6 +162,11 @@ public TypeEnum getType() { } + /** + * **molpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/Name.java b/src/main/java/com/adyen/model/checkout/Name.java index d728d115c..44e28b90f 100644 --- a/src/main/java/com/adyen/model/checkout/Name.java +++ b/src/main/java/com/adyen/model/checkout/Name.java @@ -63,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -88,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/checkout/OpenInvoiceDetails.java b/src/main/java/com/adyen/model/checkout/OpenInvoiceDetails.java index 4f7dd4afb..2a4b12aa7 100644 --- a/src/main/java/com/adyen/model/checkout/OpenInvoiceDetails.java +++ b/src/main/java/com/adyen/model/checkout/OpenInvoiceDetails.java @@ -120,6 +120,11 @@ public String getBillingAddress() { } + /** + * The address where to send the invoice. + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(String billingAddress) { @@ -145,6 +150,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -170,6 +180,11 @@ public String getDeliveryAddress() { } + /** + * The address where the goods should be delivered. + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(String deliveryAddress) { @@ -195,6 +210,11 @@ public String getPersonalDetails() { } + /** + * Shopper name, date of birth, phone number, and email address. + * + * @param personalDetails + */ @JsonProperty(JSON_PROPERTY_PERSONAL_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPersonalDetails(String personalDetails) { @@ -222,6 +242,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -248,6 +273,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -273,6 +303,11 @@ public TypeEnum getType() { } + /** + * **openinvoice** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/PayPalDetails.java b/src/main/java/com/adyen/model/checkout/PayPalDetails.java index e07ebb754..fdeb80173 100644 --- a/src/main/java/com/adyen/model/checkout/PayPalDetails.java +++ b/src/main/java/com/adyen/model/checkout/PayPalDetails.java @@ -159,6 +159,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -184,6 +189,11 @@ public String getOrderID() { } + /** + * The unique ID associated with the order. + * + * @param orderID + */ @JsonProperty(JSON_PROPERTY_ORDER_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderID(String orderID) { @@ -209,6 +219,11 @@ public String getPayeePreferred() { } + /** + * IMMEDIATE_PAYMENT_REQUIRED or UNRESTRICTED + * + * @param payeePreferred + */ @JsonProperty(JSON_PROPERTY_PAYEE_PREFERRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayeePreferred(String payeePreferred) { @@ -234,6 +249,11 @@ public String getPayerID() { } + /** + * The unique ID associated with the payer. + * + * @param payerID + */ @JsonProperty(JSON_PROPERTY_PAYER_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayerID(String payerID) { @@ -259,6 +279,11 @@ public String getPayerSelected() { } + /** + * PAYPAL or PAYPAL_CREDIT + * + * @param payerSelected + */ @JsonProperty(JSON_PROPERTY_PAYER_SELECTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayerSelected(String payerSelected) { @@ -286,6 +311,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -312,6 +342,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -337,6 +372,11 @@ public SubtypeEnum getSubtype() { } + /** + * The type of flow to initiate. + * + * @param subtype + */ @JsonProperty(JSON_PROPERTY_SUBTYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubtype(SubtypeEnum subtype) { @@ -362,6 +402,11 @@ public TypeEnum getType() { } + /** + * **paypal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/PayUUpiDetails.java b/src/main/java/com/adyen/model/checkout/PayUUpiDetails.java index 402366239..d75665d40 100644 --- a/src/main/java/com/adyen/model/checkout/PayUUpiDetails.java +++ b/src/main/java/com/adyen/model/checkout/PayUUpiDetails.java @@ -112,6 +112,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -139,6 +144,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -165,6 +175,11 @@ public String getShopperNotificationReference() { } + /** + * The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. + * + * @param shopperNotificationReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperNotificationReference(String shopperNotificationReference) { @@ -190,6 +205,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -215,6 +235,11 @@ public TypeEnum getType() { } + /** + * **payu_IN_upi** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -240,6 +265,11 @@ public String getVirtualPaymentAddress() { } + /** + * The virtual payment address for UPI. + * + * @param virtualPaymentAddress + */ @JsonProperty(JSON_PROPERTY_VIRTUAL_PAYMENT_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVirtualPaymentAddress(String virtualPaymentAddress) { diff --git a/src/main/java/com/adyen/model/checkout/PayWithGoogleDetails.java b/src/main/java/com/adyen/model/checkout/PayWithGoogleDetails.java index be9baf350..91ef7da4b 100644 --- a/src/main/java/com/adyen/model/checkout/PayWithGoogleDetails.java +++ b/src/main/java/com/adyen/model/checkout/PayWithGoogleDetails.java @@ -147,6 +147,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -172,6 +177,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -197,6 +207,11 @@ public String getGooglePayToken() { } + /** + * The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. + * + * @param googlePayToken + */ @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGooglePayToken(String googlePayToken) { @@ -224,6 +239,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -250,6 +270,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -275,6 +300,11 @@ public TypeEnum getType() { } + /** + * **paywithgoogle** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/PayWithGoogleDonations.java b/src/main/java/com/adyen/model/checkout/PayWithGoogleDonations.java new file mode 100644 index 000000000..6604e9fd3 --- /dev/null +++ b/src/main/java/com/adyen/model/checkout/PayWithGoogleDonations.java @@ -0,0 +1,384 @@ +/* + * Adyen Checkout API + * + * The version of the OpenAPI document: 71 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.checkout; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * PayWithGoogleDonations + */ +@JsonPropertyOrder({ + PayWithGoogleDonations.JSON_PROPERTY_CHECKOUT_ATTEMPT_ID, + PayWithGoogleDonations.JSON_PROPERTY_FUNDING_SOURCE, + PayWithGoogleDonations.JSON_PROPERTY_GOOGLE_PAY_TOKEN, + PayWithGoogleDonations.JSON_PROPERTY_RECURRING_DETAIL_REFERENCE, + PayWithGoogleDonations.JSON_PROPERTY_STORED_PAYMENT_METHOD_ID, + PayWithGoogleDonations.JSON_PROPERTY_TYPE +}) + +public class PayWithGoogleDonations { + public static final String JSON_PROPERTY_CHECKOUT_ATTEMPT_ID = "checkoutAttemptId"; + private String checkoutAttemptId; + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + */ + public enum FundingSourceEnum { + CREDIT("credit"), + + DEBIT("debit"); + + private String value; + + FundingSourceEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static FundingSourceEnum fromValue(String value) { + for (FundingSourceEnum b : FundingSourceEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_FUNDING_SOURCE = "fundingSource"; + private FundingSourceEnum fundingSource; + + public static final String JSON_PROPERTY_GOOGLE_PAY_TOKEN = "googlePayToken"; + private String googlePayToken; + + public static final String JSON_PROPERTY_RECURRING_DETAIL_REFERENCE = "recurringDetailReference"; + private String recurringDetailReference; + + public static final String JSON_PROPERTY_STORED_PAYMENT_METHOD_ID = "storedPaymentMethodId"; + private String storedPaymentMethodId; + + /** + * **paywithgoogle** + */ + public enum TypeEnum { + PAYWITHGOOGLE("paywithgoogle"); + + private String value; + + TypeEnum(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TypeEnum fromValue(String value) { + for (TypeEnum b : TypeEnum.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + } + + public static final String JSON_PROPERTY_TYPE = "type"; + private TypeEnum type = TypeEnum.PAYWITHGOOGLE; + + public PayWithGoogleDonations() { + } + + public PayWithGoogleDonations checkoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + return this; + } + + /** + * The checkout attempt identifier. + * @return checkoutAttemptId + **/ + @ApiModelProperty(value = "The checkout attempt identifier.") + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCheckoutAttemptId() { + return checkoutAttemptId; + } + + + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ + @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCheckoutAttemptId(String checkoutAttemptId) { + this.checkoutAttemptId = checkoutAttemptId; + } + + + public PayWithGoogleDonations fundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + return this; + } + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * @return fundingSource + **/ + @ApiModelProperty(value = "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.") + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public FundingSourceEnum getFundingSource() { + return fundingSource; + } + + + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ + @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFundingSource(FundingSourceEnum fundingSource) { + this.fundingSource = fundingSource; + } + + + public PayWithGoogleDonations googlePayToken(String googlePayToken) { + this.googlePayToken = googlePayToken; + return this; + } + + /** + * The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. + * @return googlePayToken + **/ + @ApiModelProperty(required = true, value = "The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response.") + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_TOKEN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getGooglePayToken() { + return googlePayToken; + } + + + /** + * The `token` that you obtained from the [Google Pay API](https://developers.google.com/pay/api/web/reference/response-objects#PaymentData) `PaymentData` response. + * + * @param googlePayToken + */ + @JsonProperty(JSON_PROPERTY_GOOGLE_PAY_TOKEN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGooglePayToken(String googlePayToken) { + this.googlePayToken = googlePayToken; + } + + + public PayWithGoogleDonations recurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return recurringDetailReference + * @deprecated + **/ + @Deprecated + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getRecurringDetailReference() { + return recurringDetailReference; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ + @Deprecated + @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setRecurringDetailReference(String recurringDetailReference) { + this.recurringDetailReference = recurringDetailReference; + } + + + public PayWithGoogleDonations storedPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + return this; + } + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * @return storedPaymentMethodId + **/ + @ApiModelProperty(value = "This is the `recurringDetailReference` returned in the response when you created the token.") + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getStoredPaymentMethodId() { + return storedPaymentMethodId; + } + + + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ + @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setStoredPaymentMethodId(String storedPaymentMethodId) { + this.storedPaymentMethodId = storedPaymentMethodId; + } + + + public PayWithGoogleDonations type(TypeEnum type) { + this.type = type; + return this; + } + + /** + * **paywithgoogle** + * @return type + **/ + @ApiModelProperty(value = "**paywithgoogle**") + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TypeEnum getType() { + return type; + } + + + /** + * **paywithgoogle** + * + * @param type + */ + @JsonProperty(JSON_PROPERTY_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setType(TypeEnum type) { + this.type = type; + } + + + /** + * Return true if this PayWithGoogleDonations object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PayWithGoogleDonations payWithGoogleDonations = (PayWithGoogleDonations) o; + return Objects.equals(this.checkoutAttemptId, payWithGoogleDonations.checkoutAttemptId) && + Objects.equals(this.fundingSource, payWithGoogleDonations.fundingSource) && + Objects.equals(this.googlePayToken, payWithGoogleDonations.googlePayToken) && + Objects.equals(this.recurringDetailReference, payWithGoogleDonations.recurringDetailReference) && + Objects.equals(this.storedPaymentMethodId, payWithGoogleDonations.storedPaymentMethodId) && + Objects.equals(this.type, payWithGoogleDonations.type); + } + + @Override + public int hashCode() { + return Objects.hash(checkoutAttemptId, fundingSource, googlePayToken, recurringDetailReference, storedPaymentMethodId, type); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PayWithGoogleDonations {\n"); + sb.append(" checkoutAttemptId: ").append(toIndentedString(checkoutAttemptId)).append("\n"); + sb.append(" fundingSource: ").append(toIndentedString(fundingSource)).append("\n"); + sb.append(" googlePayToken: ").append(toIndentedString(googlePayToken)).append("\n"); + sb.append(" recurringDetailReference: ").append(toIndentedString(recurringDetailReference)).append("\n"); + sb.append(" storedPaymentMethodId: ").append(toIndentedString(storedPaymentMethodId)).append("\n"); + sb.append(" type: ").append(toIndentedString(type)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of PayWithGoogleDonations given an JSON string + * + * @param jsonString JSON string + * @return An instance of PayWithGoogleDonations + * @throws JsonProcessingException if the JSON string is invalid with respect to PayWithGoogleDonations + */ + public static PayWithGoogleDonations fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, PayWithGoogleDonations.class); + } +/** + * Convert an instance of PayWithGoogleDonations to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateRequest.java b/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateRequest.java index 5752651e6..b4a8a48bb 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateRequest.java @@ -126,6 +126,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -151,6 +156,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -176,6 +186,11 @@ public IndustryUsageEnum getIndustryUsage() { } + /** + * The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment** + * + * @param industryUsage + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryUsage(IndustryUsageEnum industryUsage) { @@ -209,6 +224,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -234,6 +254,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -259,6 +284,11 @@ public String getReference() { } + /** + * Your reference for the amount update request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -292,6 +322,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateResponse.java b/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateResponse.java index ac16ca533..bc8527e3c 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentAmountUpdateResponse.java @@ -166,6 +166,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -191,6 +196,11 @@ public IndustryUsageEnum getIndustryUsage() { } + /** + * The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment** + * + * @param industryUsage + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryUsage(IndustryUsageEnum industryUsage) { @@ -224,6 +234,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -249,6 +264,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -274,6 +294,11 @@ public String getPaymentPspReference() { } + /** + * The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to update. + * + * @param paymentPspReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentPspReference(String paymentPspReference) { @@ -299,6 +324,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the amount update request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -324,6 +354,11 @@ public String getReference() { } + /** + * Your reference for the amount update request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -357,6 +392,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -382,6 +422,11 @@ public StatusEnum getStatus() { } + /** + * The status of your request. This will always have the value **received**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentCancelRequest.java b/src/main/java/com/adyen/model/checkout/PaymentCancelRequest.java index efbc9724a..302ee7061 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentCancelRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentCancelRequest.java @@ -68,6 +68,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -93,6 +98,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -118,6 +128,11 @@ public String getReference() { } + /** + * Your reference for the cancel request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentCancelResponse.java b/src/main/java/com/adyen/model/checkout/PaymentCancelResponse.java index da83ce1a5..c410ea3dc 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentCancelResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentCancelResponse.java @@ -108,6 +108,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -133,6 +138,11 @@ public String getPaymentPspReference() { } + /** + * The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to cancel. + * + * @param paymentPspReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentPspReference(String paymentPspReference) { @@ -158,6 +168,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the cancel request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -183,6 +198,11 @@ public String getReference() { } + /** + * Your reference for the cancel request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -208,6 +228,11 @@ public StatusEnum getStatus() { } + /** + * The status of your request. This will always have the value **received**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentCaptureRequest.java b/src/main/java/com/adyen/model/checkout/PaymentCaptureRequest.java index 92f37f1a1..e1a7f795e 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentCaptureRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentCaptureRequest.java @@ -95,6 +95,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -120,6 +125,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -153,6 +163,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -178,6 +193,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -203,6 +223,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -228,6 +253,11 @@ public String getReference() { } + /** + * Your reference for the capture request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -261,6 +291,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -294,6 +329,11 @@ public List getSubMerchants() { } + /** + * A List of sub-merchants. + * + * @param subMerchants + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchants(List subMerchants) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentCaptureResponse.java b/src/main/java/com/adyen/model/checkout/PaymentCaptureResponse.java index 840f92e8e..48183a59c 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentCaptureResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentCaptureResponse.java @@ -135,6 +135,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -168,6 +173,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -193,6 +203,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -218,6 +233,11 @@ public String getPaymentPspReference() { } + /** + * The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to capture. + * + * @param paymentPspReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentPspReference(String paymentPspReference) { @@ -243,6 +263,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -268,6 +293,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the capture request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -293,6 +323,11 @@ public String getReference() { } + /** + * Your reference for the capture request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -326,6 +361,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -351,6 +391,11 @@ public StatusEnum getStatus() { } + /** + * The status of your request. This will always have the value **received**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -384,6 +429,11 @@ public List getSubMerchants() { } + /** + * List of sub-merchants. + * + * @param subMerchants + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchants(List subMerchants) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentCompletionDetails.java b/src/main/java/com/adyen/model/checkout/PaymentCompletionDetails.java index 4c49997a6..6c5ad4f41 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentCompletionDetails.java +++ b/src/main/java/com/adyen/model/checkout/PaymentCompletionDetails.java @@ -127,6 +127,11 @@ public String getMD() { } + /** + * A payment session identifier returned by the card issuer. + * + * @param MD + */ @JsonProperty(JSON_PROPERTY_M_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMD(String MD) { @@ -152,6 +157,11 @@ public String getPaReq() { } + /** + * (3D) Payment Authentication Request data for the card issuer. + * + * @param paReq + */ @JsonProperty(JSON_PROPERTY_PA_REQ) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaReq(String paReq) { @@ -177,6 +187,11 @@ public String getPaRes() { } + /** + * (3D) Payment Authentication Response data by the card issuer. + * + * @param paRes + */ @JsonProperty(JSON_PROPERTY_PA_RES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaRes(String paRes) { @@ -202,6 +217,11 @@ public String getAuthorizationToken() { } + /** + * authorizationToken + * + * @param authorizationToken + */ @JsonProperty(JSON_PROPERTY_AUTHORIZATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorizationToken(String authorizationToken) { @@ -227,6 +247,11 @@ public String getBillingToken() { } + /** + * PayPal-generated token for recurring payments. + * + * @param billingToken + */ @JsonProperty(JSON_PROPERTY_BILLING_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingToken(String billingToken) { @@ -252,6 +277,11 @@ public String getCupsecureplusSmscode() { } + /** + * The SMS verification code collected from the shopper. + * + * @param cupsecureplusSmscode + */ @JsonProperty(JSON_PROPERTY_CUPSECUREPLUS_SMSCODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCupsecureplusSmscode(String cupsecureplusSmscode) { @@ -277,6 +307,11 @@ public String getFacilitatorAccessToken() { } + /** + * PayPal-generated third party access token. + * + * @param facilitatorAccessToken + */ @JsonProperty(JSON_PROPERTY_FACILITATOR_ACCESS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFacilitatorAccessToken(String facilitatorAccessToken) { @@ -302,6 +337,11 @@ public String getOneTimePasscode() { } + /** + * A random number sent to the mobile phone number of the shopper to verify the payment. + * + * @param oneTimePasscode + */ @JsonProperty(JSON_PROPERTY_ONE_TIME_PASSCODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOneTimePasscode(String oneTimePasscode) { @@ -327,6 +367,11 @@ public String getOrderID() { } + /** + * PayPal-assigned ID for the order. + * + * @param orderID + */ @JsonProperty(JSON_PROPERTY_ORDER_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderID(String orderID) { @@ -352,6 +397,11 @@ public String getPayerID() { } + /** + * PayPal-assigned ID for the payer (shopper). + * + * @param payerID + */ @JsonProperty(JSON_PROPERTY_PAYER_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayerID(String payerID) { @@ -377,6 +427,11 @@ public String getPayload() { } + /** + * Payload appended to the `returnURL` as a result of the redirect. + * + * @param payload + */ @JsonProperty(JSON_PROPERTY_PAYLOAD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayload(String payload) { @@ -402,6 +457,11 @@ public String getPaymentID() { } + /** + * PayPal-generated ID for the payment. + * + * @param paymentID + */ @JsonProperty(JSON_PROPERTY_PAYMENT_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentID(String paymentID) { @@ -427,6 +487,11 @@ public String getPaymentStatus() { } + /** + * Value passed from the WeChat MiniProgram `wx.requestPayment` **complete** callback. Possible values: any value starting with `requestPayment:`. + * + * @param paymentStatus + */ @JsonProperty(JSON_PROPERTY_PAYMENT_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentStatus(String paymentStatus) { @@ -452,6 +517,11 @@ public String getRedirectResult() { } + /** + * The result of the redirect as appended to the `returnURL`. + * + * @param redirectResult + */ @JsonProperty(JSON_PROPERTY_REDIRECT_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectResult(String redirectResult) { @@ -477,6 +547,11 @@ public String getResultCode() { } + /** + * Value you received from the WeChat Pay SDK. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(String resultCode) { @@ -502,6 +577,11 @@ public String getThreeDSResult() { } + /** + * Base64-encoded string returned by the Component after the challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`. + * + * @param threeDSResult + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSResult(String threeDSResult) { @@ -527,6 +607,11 @@ public String getThreeds2ChallengeResult() { } + /** + * Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `transStatus`. + * + * @param threeds2ChallengeResult + */ @JsonProperty(JSON_PROPERTY_THREEDS2_CHALLENGE_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeds2ChallengeResult(String threeds2ChallengeResult) { @@ -552,6 +637,11 @@ public String getThreeds2Fingerprint() { } + /** + * Base64-encoded string returned by the Component after the challenge flow. It contains the following parameter: `threeDSCompInd`. + * + * @param threeds2Fingerprint + */ @JsonProperty(JSON_PROPERTY_THREEDS2_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeds2Fingerprint(String threeds2Fingerprint) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentDetails.java b/src/main/java/com/adyen/model/checkout/PaymentDetails.java index 3922ca31e..03423812e 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentDetails.java +++ b/src/main/java/com/adyen/model/checkout/PaymentDetails.java @@ -270,6 +270,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -295,6 +300,11 @@ public TypeEnum getType() { } + /** + * The payment method type. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentDetailsRequest.java b/src/main/java/com/adyen/model/checkout/PaymentDetailsRequest.java index 65eb6c31a..59cc8e291 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentDetailsRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentDetailsRequest.java @@ -73,6 +73,11 @@ public DetailsRequestAuthenticationData getAuthenticationData() { } + /** + * authenticationData + * + * @param authenticationData + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationData(DetailsRequestAuthenticationData authenticationData) { @@ -98,6 +103,11 @@ public PaymentCompletionDetails getDetails() { } + /** + * details + * + * @param details + */ @JsonProperty(JSON_PROPERTY_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetails(PaymentCompletionDetails details) { @@ -123,6 +133,11 @@ public String getPaymentData() { } + /** + * Encoded payment data. For [authorizing a payment after using 3D Secure 2 Authentication-only](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only/#authorise-the-payment-with-adyen): If you received `resultCode`: **AuthenticationNotRequired** in the `/payments` response, use the `threeDSPaymentData` from the same response. If you received `resultCode`: **AuthenticationFinished** in the `/payments` response, use the `action.paymentData` from the same response. + * + * @param paymentData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentData(String paymentData) { @@ -150,6 +165,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * Change the `authenticationOnly` indicator originally set in the `/payments` request. Only needs to be set if you want to modify the value set previously. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/src/main/java/com/adyen/model/checkout/PaymentDetailsResponse.java b/src/main/java/com/adyen/model/checkout/PaymentDetailsResponse.java index 073429f1d..ce471d419 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentDetailsResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentDetailsResponse.java @@ -191,6 +191,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -216,6 +221,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -241,6 +251,11 @@ public String getDonationToken() { } + /** + * Donation Token containing payment details for Adyen Giving. + * + * @param donationToken + */ @JsonProperty(JSON_PROPERTY_DONATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationToken(String donationToken) { @@ -266,6 +281,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -291,6 +311,11 @@ public String getMerchantReference() { } + /** + * The reference used during the /payments request. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -316,6 +341,11 @@ public CheckoutOrderResponse getOrder() { } + /** + * order + * + * @param order + */ @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrder(CheckoutOrderResponse order) { @@ -341,6 +371,11 @@ public ResponsePaymentMethod getPaymentMethod() { } + /** + * paymentMethod + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(ResponsePaymentMethod paymentMethod) { @@ -366,6 +401,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -391,6 +431,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -416,6 +461,11 @@ public String getRefusalReasonCode() { } + /** + * Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReasonCode + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReasonCode(String refusalReasonCode) { @@ -441,6 +491,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -466,6 +521,11 @@ public String getShopperLocale() { } + /** + * The shopperLocale. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -491,6 +551,11 @@ public ThreeDS2ResponseData getThreeDS2ResponseData() { } + /** + * threeDS2ResponseData + * + * @param threeDS2ResponseData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESPONSE_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2ResponseData(ThreeDS2ResponseData threeDS2ResponseData) { @@ -516,6 +581,11 @@ public ThreeDS2Result getThreeDS2Result() { } + /** + * threeDS2Result + * + * @param threeDS2Result + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Result(ThreeDS2Result threeDS2Result) { @@ -541,6 +611,11 @@ public String getThreeDSPaymentData() { } + /** + * When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. + * + * @param threeDSPaymentData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSPaymentData(String threeDSPaymentData) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentLinkRequest.java b/src/main/java/com/adyen/model/checkout/PaymentLinkRequest.java index 995d3214a..40491c033 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentLinkRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentLinkRequest.java @@ -344,6 +344,11 @@ public List getAllowedPaymentMethods() { } + /** + * List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param allowedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_ALLOWED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedPaymentMethods(List allowedPaymentMethods) { @@ -369,6 +374,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -394,6 +404,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -419,6 +434,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -452,6 +472,11 @@ public List getBlockedPaymentMethods() { } + /** + * List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param blockedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_BLOCKED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlockedPaymentMethods(List blockedPaymentMethods) { @@ -477,6 +502,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -502,6 +532,11 @@ public String getCountryCode() { } + /** + * The shopper's two-letter country code. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -527,6 +562,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -552,6 +592,11 @@ public OffsetDateTime getDeliverAt() { } + /** + * The date and time when the purchased goods should be delivered. [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**. + * + * @param deliverAt + */ @JsonProperty(JSON_PROPERTY_DELIVER_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliverAt(OffsetDateTime deliverAt) { @@ -577,6 +622,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -602,6 +652,11 @@ public String getDescription() { } + /** + * A short description visible on the payment page. Maximum length: 280 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -627,6 +682,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum expiry date is 70 days after the payment link is created. If not provided, the payment link expires 24 hours after it was created. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { @@ -660,6 +720,11 @@ public Map getInstallmentOptions() { } + /** + * A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options. + * + * @param installmentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentOptions(Map installmentOptions) { @@ -693,6 +758,11 @@ public List getLineItems() { } + /** + * Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -718,6 +788,11 @@ public Boolean getManualCapture() { } + /** + * Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). + * + * @param manualCapture + */ @JsonProperty(JSON_PROPERTY_MANUAL_CAPTURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setManualCapture(Boolean manualCapture) { @@ -743,6 +818,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -768,6 +848,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier for which the payment link is created. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -793,6 +878,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -826,6 +916,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error \"177\" occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. Otherwise, error \"178\" occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -851,6 +946,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable amount, which follows a fixed schedule. * **CardOnFile** – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * **UnscheduledCardOnFile** – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -876,6 +976,11 @@ public String getReference() { } + /** + * A reference that is used to uniquely identify the payment in future communications about the payment status. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -909,6 +1014,11 @@ public List getRequiredShopperFields() { } + /** + * List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information). Possible values: * **billingAddress** – The address where to send the invoice. * **deliveryAddress** – The address where the purchased goods should be delivered. * **shopperEmail** – The shopper's email address. * **shopperName** – The shopper's full name. * **telephoneNumber** – The shopper's phone number. + * + * @param requiredShopperFields + */ @JsonProperty(JSON_PROPERTY_REQUIRED_SHOPPER_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequiredShopperFields(List requiredShopperFields) { @@ -934,6 +1044,11 @@ public String getReturnUrl() { } + /** + * Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL. + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -959,6 +1074,11 @@ public Boolean getReusable() { } + /** + * Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only. + * + * @param reusable + */ @JsonProperty(JSON_PROPERTY_REUSABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReusable(Boolean reusable) { @@ -984,6 +1104,11 @@ public RiskData getRiskData() { } + /** + * riskData + * + * @param riskData + */ @JsonProperty(JSON_PROPERTY_RISK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskData(RiskData riskData) { @@ -1009,6 +1134,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1034,6 +1164,11 @@ public String getShopperLocale() { } + /** + * The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language). + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1059,6 +1194,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1084,6 +1224,11 @@ public String getShopperReference() { } + /** + * Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1109,6 +1254,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1134,6 +1284,11 @@ public Boolean getShowRemovePaymentMethodButton() { } + /** + * Set to **false** to hide the button that lets the shopper remove a stored payment method. + * + * @param showRemovePaymentMethodButton + */ @JsonProperty(JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) { @@ -1159,6 +1314,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1184,6 +1344,11 @@ public Boolean getSplitCardFundingSources() { } + /** + * Boolean value indicating whether the card payment method should be split into separate debit and credit options. + * + * @param splitCardFundingSources + */ @JsonProperty(JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitCardFundingSources(Boolean splitCardFundingSources) { @@ -1217,6 +1382,11 @@ public List getSplits() { } + /** + * An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1242,6 +1412,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1267,6 +1442,11 @@ public StorePaymentMethodModeEnum getStorePaymentMethodMode() { } + /** + * Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter. + * + * @param storePaymentMethodMode + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethodMode(StorePaymentMethodModeEnum storePaymentMethodMode) { @@ -1292,6 +1472,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1317,6 +1502,11 @@ public String getThemeId() { } + /** + * A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area. + * + * @param themeId + */ @JsonProperty(JSON_PROPERTY_THEME_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThemeId(String themeId) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentLinkResponse.java b/src/main/java/com/adyen/model/checkout/PaymentLinkResponse.java index db990085f..30b16a9d6 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentLinkResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentLinkResponse.java @@ -401,6 +401,11 @@ public List getAllowedPaymentMethods() { } + /** + * List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param allowedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_ALLOWED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedPaymentMethods(List allowedPaymentMethods) { @@ -426,6 +431,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -451,6 +461,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -476,6 +491,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -509,6 +529,11 @@ public List getBlockedPaymentMethods() { } + /** + * List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param blockedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_BLOCKED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlockedPaymentMethods(List blockedPaymentMethods) { @@ -534,6 +559,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -559,6 +589,11 @@ public String getCountryCode() { } + /** + * The shopper's two-letter country code. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -584,6 +619,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -609,6 +649,11 @@ public OffsetDateTime getDeliverAt() { } + /** + * The date and time when the purchased goods should be delivered. [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**. + * + * @param deliverAt + */ @JsonProperty(JSON_PROPERTY_DELIVER_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliverAt(OffsetDateTime deliverAt) { @@ -634,6 +679,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -659,6 +709,11 @@ public String getDescription() { } + /** + * A short description visible on the payment page. Maximum length: 280 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -684,6 +739,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date when the payment link expires. [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format with time zone offset: YYYY-MM-DDThh:mm:ss+TZD, for example, **2020-12-18T10:15:30+01:00**. The maximum expiry date is 70 days after the payment link is created. If not provided, the payment link expires 24 hours after it was created. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { @@ -709,6 +769,11 @@ public String getId() { } + /** + * A unique identifier of the payment link. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -742,6 +807,11 @@ public Map getInstallmentOptions() { } + /** + * A set of key-value pairs that specifies the installment options available per payment method. The key must be a payment method name in lowercase. For example, **card** to specify installment options for all cards, or **visa** or **mc**. The value must be an object containing the installment options. + * + * @param installmentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentOptions(Map installmentOptions) { @@ -775,6 +845,11 @@ public List getLineItems() { } + /** + * Price and product information about the purchased items, to be included on the invoice sent to the shopper. This parameter is required for open invoice (_buy now, pay later_) payment methods such Afterpay, Clearpay, Klarna, RatePay, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -800,6 +875,11 @@ public Boolean getManualCapture() { } + /** + * Indicates if the payment must be [captured manually](https://docs.adyen.com/online-payments/capture). + * + * @param manualCapture + */ @JsonProperty(JSON_PROPERTY_MANUAL_CAPTURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setManualCapture(Boolean manualCapture) { @@ -825,6 +905,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -850,6 +935,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier for which the payment link is created. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -875,6 +965,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (for example, order auth-rate). The reference should be unique per billing cycle. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -908,6 +1003,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limitations: * Maximum 20 key-value pairs per request. Otherwise, error \"177\" occurs: \"Metadata size exceeds limit\" * Maximum 20 characters per key. Otherwise, error \"178\" occurs: \"Metadata key size exceeds limit\" * A key cannot have the name `checkout.linkId`. Any value that you provide with this key is going to be replaced by the real payment link ID. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -933,6 +1033,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when `storePaymentMethodMode` is set to **askForConsent** or **enabled**. Possible values: * **Subscription** – A transaction for a fixed or variable amount, which follows a fixed schedule. * **CardOnFile** – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * **UnscheduledCardOnFile** – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or has variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -958,6 +1063,11 @@ public String getReference() { } + /** + * A reference that is used to uniquely identify the payment in future communications about the payment status. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -991,6 +1101,11 @@ public List getRequiredShopperFields() { } + /** + * List of fields that the shopper has to provide on the payment page before completing the payment. For more information, refer to [Provide shopper information](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#shopper-information). Possible values: * **billingAddress** – The address where to send the invoice. * **deliveryAddress** – The address where the purchased goods should be delivered. * **shopperEmail** – The shopper's email address. * **shopperName** – The shopper's full name. * **telephoneNumber** – The shopper's phone number. + * + * @param requiredShopperFields + */ @JsonProperty(JSON_PROPERTY_REQUIRED_SHOPPER_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequiredShopperFields(List requiredShopperFields) { @@ -1016,6 +1131,11 @@ public String getReturnUrl() { } + /** + * Website URL used for redirection after payment is completed. If provided, a **Continue** button will be shown on the payment page. If shoppers select the button, they are redirected to the specified URL. + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -1041,6 +1161,11 @@ public Boolean getReusable() { } + /** + * Indicates whether the payment link can be reused for multiple payments. If not provided, this defaults to **false** which means the link can be used for one successful payment only. + * + * @param reusable + */ @JsonProperty(JSON_PROPERTY_REUSABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReusable(Boolean reusable) { @@ -1066,6 +1191,11 @@ public RiskData getRiskData() { } + /** + * riskData + * + * @param riskData + */ @JsonProperty(JSON_PROPERTY_RISK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskData(RiskData riskData) { @@ -1091,6 +1221,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1116,6 +1251,11 @@ public String getShopperLocale() { } + /** + * The language to be used in the payment page, specified by a combination of a language and country code. For example, `en-US`. For a list of shopper locales that Pay by Link supports, refer to [Language and localization](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#language). + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1141,6 +1281,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1166,6 +1311,11 @@ public String getShopperReference() { } + /** + * Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1191,6 +1341,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1216,6 +1371,11 @@ public Boolean getShowRemovePaymentMethodButton() { } + /** + * Set to **false** to hide the button that lets the shopper remove a stored payment method. + * + * @param showRemovePaymentMethodButton + */ @JsonProperty(JSON_PROPERTY_SHOW_REMOVE_PAYMENT_METHOD_BUTTON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShowRemovePaymentMethodButton(Boolean showRemovePaymentMethodButton) { @@ -1241,6 +1401,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1266,6 +1431,11 @@ public Boolean getSplitCardFundingSources() { } + /** + * Boolean value indicating whether the card payment method should be split into separate debit and credit options. + * + * @param splitCardFundingSources + */ @JsonProperty(JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitCardFundingSources(Boolean splitCardFundingSources) { @@ -1299,6 +1469,11 @@ public List getSplits() { } + /** + * An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1324,6 +1499,11 @@ public StatusEnum getStatus() { } + /** + * Status of the payment link. Possible values: * **active**: The link can be used to make payments. * **expired**: The expiry date for the payment link has passed. Shoppers can no longer use the link to make payments. * **completed**: The shopper completed the payment. * **paymentPending**: The shopper is in the process of making the payment. Applies to payment methods with an asynchronous flow. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -1349,6 +1529,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1374,6 +1559,11 @@ public StorePaymentMethodModeEnum getStorePaymentMethodMode() { } + /** + * Indicates if the details of the payment method will be stored for the shopper. Possible values: * **disabled** – No details will be stored (default). * **askForConsent** – If the `shopperReference` is provided, the UI lets the shopper choose if they want their payment details to be stored. * **enabled** – If the `shopperReference` is provided, the details will be stored without asking the shopper for consent. When set to **askForConsent** or **enabled**, you must also include the `recurringProcessingModel` parameter. + * + * @param storePaymentMethodMode + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethodMode(StorePaymentMethodModeEnum storePaymentMethodMode) { @@ -1399,6 +1589,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1424,6 +1619,11 @@ public String getThemeId() { } + /** + * A [theme](https://docs.adyen.com/unified-commerce/pay-by-link/payment-links/api#themes) to customize the appearance of the payment page. If not specified, the payment page is rendered according to the theme set as default in your Customer Area. + * + * @param themeId + */ @JsonProperty(JSON_PROPERTY_THEME_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThemeId(String themeId) { @@ -1449,6 +1649,11 @@ public OffsetDateTime getUpdatedAt() { } + /** + * The date when the payment link status was updated. [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**. + * + * @param updatedAt + */ @JsonProperty(JSON_PROPERTY_UPDATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpdatedAt(OffsetDateTime updatedAt) { @@ -1474,6 +1679,11 @@ public String getUrl() { } + /** + * The URL at which the shopper can complete the payment. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentMethod.java b/src/main/java/com/adyen/model/checkout/PaymentMethod.java index 761be815c..a8131f644 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentMethod.java +++ b/src/main/java/com/adyen/model/checkout/PaymentMethod.java @@ -133,6 +133,11 @@ public String getBrand() { } + /** + * Brand for the selected gift card. For example: plastix, hmclub. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -166,6 +171,11 @@ public List getBrands() { } + /** + * List of possible brands. For example: visa, mc. + * + * @param brands + */ @JsonProperty(JSON_PROPERTY_BRANDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrands(List brands) { @@ -199,6 +209,11 @@ public Map getConfiguration() { } + /** + * The configuration of the payment method. + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(Map configuration) { @@ -224,6 +239,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source of the payment method. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -249,6 +269,11 @@ public PaymentMethodGroup getGroup() { } + /** + * group + * + * @param group + */ @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGroup(PaymentMethodGroup group) { @@ -284,6 +309,11 @@ public List getInputDetails() { } + /** + * All input details to be provided to complete the payment with this payment method. + * + * @param inputDetails + */ @Deprecated @JsonProperty(JSON_PROPERTY_INPUT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -318,6 +348,11 @@ public List getIssuers() { } + /** + * A list of issuers for this payment method. + * + * @param issuers + */ @JsonProperty(JSON_PROPERTY_ISSUERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuers(List issuers) { @@ -343,6 +378,11 @@ public String getName() { } + /** + * The displayable name of this payment method. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -368,6 +408,11 @@ public String getType() { } + /** + * The unique payment method code. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentMethodGroup.java b/src/main/java/com/adyen/model/checkout/PaymentMethodGroup.java index e1b9041f1..b94eff1de 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentMethodGroup.java +++ b/src/main/java/com/adyen/model/checkout/PaymentMethodGroup.java @@ -67,6 +67,11 @@ public String getName() { } + /** + * The name of the group. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -92,6 +97,11 @@ public String getPaymentMethodData() { } + /** + * Echo data to be used if the payment method is displayed as part of this group. + * + * @param paymentMethodData + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodData(String paymentMethodData) { @@ -117,6 +127,11 @@ public String getType() { } + /** + * The unique code of the group. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentMethodIssuer.java b/src/main/java/com/adyen/model/checkout/PaymentMethodIssuer.java index 57c076f15..1219b4131 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentMethodIssuer.java +++ b/src/main/java/com/adyen/model/checkout/PaymentMethodIssuer.java @@ -67,6 +67,11 @@ public Boolean getDisabled() { } + /** + * A boolean value indicating whether this issuer is unavailable. Can be `true` whenever the issuer is offline. + * + * @param disabled + */ @JsonProperty(JSON_PROPERTY_DISABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisabled(Boolean disabled) { @@ -92,6 +97,11 @@ public String getId() { } + /** + * The unique identifier of this issuer, to submit in requests to /payments. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -117,6 +127,11 @@ public String getName() { } + /** + * A localized name of the issuer. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentMethodsRequest.java b/src/main/java/com/adyen/model/checkout/PaymentMethodsRequest.java index fc2b7a57b..cd5aa7c60 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentMethodsRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentMethodsRequest.java @@ -154,6 +154,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -187,6 +192,11 @@ public List getAllowedPaymentMethods() { } + /** + * List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param allowedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_ALLOWED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedPaymentMethods(List allowedPaymentMethods) { @@ -212,6 +222,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -245,6 +260,11 @@ public List getBlockedPaymentMethods() { } + /** + * List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param blockedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_BLOCKED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlockedPaymentMethods(List blockedPaymentMethods) { @@ -270,6 +290,11 @@ public ChannelEnum getChannel() { } + /** + * The platform where a payment transaction takes place. This field can be used for filtering out payment methods that are only available on specific platforms. Possible values: * iOS * Android * Web + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(ChannelEnum channel) { @@ -295,6 +320,11 @@ public String getCountryCode() { } + /** + * The shopper's country code. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -320,6 +350,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -345,6 +380,11 @@ public EncryptedOrderData getOrder() { } + /** + * order + * + * @param order + */ @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrder(EncryptedOrderData order) { @@ -370,6 +410,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -395,6 +440,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -420,6 +470,11 @@ public Boolean getSplitCardFundingSources() { } + /** + * Boolean value indicating whether the card payment method should be split into separate debit and credit options. + * + * @param splitCardFundingSources + */ @JsonProperty(JSON_PROPERTY_SPLIT_CARD_FUNDING_SOURCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitCardFundingSources(Boolean splitCardFundingSources) { @@ -445,6 +500,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentMethodsResponse.java b/src/main/java/com/adyen/model/checkout/PaymentMethodsResponse.java index ab381caff..8f5d4e428 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentMethodsResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentMethodsResponse.java @@ -75,6 +75,11 @@ public List getPaymentMethods() { } + /** + * Detailed list of payment methods required to generate payment forms. + * + * @param paymentMethods + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethods(List paymentMethods) { @@ -108,6 +113,11 @@ public List getStoredPaymentMethods() { } + /** + * List of all stored payment methods. + * + * @param storedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethods(List storedPaymentMethods) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentRefundRequest.java b/src/main/java/com/adyen/model/checkout/PaymentRefundRequest.java index 48f7ffb1a..a05b2b9f6 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentRefundRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentRefundRequest.java @@ -134,6 +134,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -159,6 +164,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -192,6 +202,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -217,6 +232,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -242,6 +262,11 @@ public MerchantRefundReasonEnum getMerchantRefundReason() { } + /** + * Your reason for the refund request + * + * @param merchantRefundReason + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFUND_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRefundReason(MerchantRefundReasonEnum merchantRefundReason) { @@ -267,6 +292,11 @@ public String getReference() { } + /** + * Your reference for the refund request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -300,6 +330,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -325,6 +360,11 @@ public String getStore() { } + /** + * The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentRefundResponse.java b/src/main/java/com/adyen/model/checkout/PaymentRefundResponse.java index 5861a47e0..b40bc7297 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentRefundResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentRefundResponse.java @@ -174,6 +174,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -207,6 +212,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -232,6 +242,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -257,6 +272,11 @@ public MerchantRefundReasonEnum getMerchantRefundReason() { } + /** + * Your reason for the refund request. + * + * @param merchantRefundReason + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFUND_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRefundReason(MerchantRefundReasonEnum merchantRefundReason) { @@ -282,6 +302,11 @@ public String getPaymentPspReference() { } + /** + * The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to refund. + * + * @param paymentPspReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentPspReference(String paymentPspReference) { @@ -307,6 +332,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the refund request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -332,6 +362,11 @@ public String getReference() { } + /** + * Your reference for the refund request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -365,6 +400,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -390,6 +430,11 @@ public StatusEnum getStatus() { } + /** + * The status of your request. This will always have the value **received**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -415,6 +460,11 @@ public String getStore() { } + /** + * The online store or [physical store](https://docs.adyen.com/point-of-sale/design-your-integration/determine-account-structure/#create-stores) that is processing the refund. This must be the same as the store name configured in your Customer Area. Otherwise, you get an error and the refund fails. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentRequest.java b/src/main/java/com/adyen/model/checkout/PaymentRequest.java index d714c2628..e373923fd 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentRequest.java @@ -536,6 +536,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -561,6 +566,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -594,6 +604,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -619,6 +634,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -644,6 +664,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -669,6 +694,11 @@ public AuthenticationData getAuthenticationData() { } + /** + * authenticationData + * + * @param authenticationData + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationData(AuthenticationData authenticationData) { @@ -694,6 +724,11 @@ public BillingAddress getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(BillingAddress billingAddress) { @@ -719,6 +754,11 @@ public BrowserInfo getBrowserInfo() { } + /** + * browserInfo + * + * @param browserInfo + */ @JsonProperty(JSON_PROPERTY_BROWSER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrowserInfo(BrowserInfo browserInfo) { @@ -744,6 +784,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -769,6 +814,11 @@ public ChannelEnum getChannel() { } + /** + * The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(ChannelEnum channel) { @@ -794,6 +844,11 @@ public String getCheckoutAttemptId() { } + /** + * Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -819,6 +874,11 @@ public Company getCompany() { } + /** + * company + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(Company company) { @@ -846,6 +906,11 @@ public String getConversionId() { } + /** + * Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. + * + * @param conversionId + */ @Deprecated @JsonProperty(JSON_PROPERTY_CONVERSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -872,6 +937,11 @@ public String getCountryCode() { } + /** + * The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -897,6 +967,11 @@ public OffsetDateTime getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(OffsetDateTime dateOfBirth) { @@ -922,6 +997,11 @@ public ForexQuote getDccQuote() { } + /** + * dccQuote + * + * @param dccQuote + */ @JsonProperty(JSON_PROPERTY_DCC_QUOTE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccQuote(ForexQuote dccQuote) { @@ -947,6 +1027,11 @@ public OffsetDateTime getDeliverAt() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliverAt + */ @JsonProperty(JSON_PROPERTY_DELIVER_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliverAt(OffsetDateTime deliverAt) { @@ -972,6 +1057,11 @@ public DeliveryAddress getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(DeliveryAddress deliveryAddress) { @@ -999,6 +1089,11 @@ public OffsetDateTime getDeliveryDate() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliveryDate + */ @Deprecated @JsonProperty(JSON_PROPERTY_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -1025,6 +1120,11 @@ public String getDeviceFingerprint() { } + /** + * A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + * + * @param deviceFingerprint + */ @JsonProperty(JSON_PROPERTY_DEVICE_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceFingerprint(String deviceFingerprint) { @@ -1050,6 +1150,11 @@ public Boolean getEnableOneClick() { } + /** + * When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments. + * + * @param enableOneClick + */ @JsonProperty(JSON_PROPERTY_ENABLE_ONE_CLICK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableOneClick(Boolean enableOneClick) { @@ -1075,6 +1180,11 @@ public Boolean getEnablePayOut() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for payouts. + * + * @param enablePayOut + */ @JsonProperty(JSON_PROPERTY_ENABLE_PAY_OUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnablePayOut(Boolean enablePayOut) { @@ -1100,6 +1210,11 @@ public Boolean getEnableRecurring() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. + * + * @param enableRecurring + */ @JsonProperty(JSON_PROPERTY_ENABLE_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableRecurring(Boolean enableRecurring) { @@ -1125,6 +1240,11 @@ public EntityTypeEnum getEntityType() { } + /** + * The type of the entity the payment is processed for. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(EntityTypeEnum entityType) { @@ -1150,6 +1270,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -1175,6 +1300,11 @@ public FundOrigin getFundOrigin() { } + /** + * fundOrigin + * + * @param fundOrigin + */ @JsonProperty(JSON_PROPERTY_FUND_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundOrigin(FundOrigin fundOrigin) { @@ -1200,6 +1330,11 @@ public FundRecipient getFundRecipient() { } + /** + * fundRecipient + * + * @param fundRecipient + */ @JsonProperty(JSON_PROPERTY_FUND_RECIPIENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundRecipient(FundRecipient fundRecipient) { @@ -1225,6 +1360,11 @@ public IndustryUsageEnum getIndustryUsage() { } + /** + * The reason for the amount update. Possible values: * **delayedCharge** * **noShow** * **installment** + * + * @param industryUsage + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryUsage(IndustryUsageEnum industryUsage) { @@ -1250,6 +1390,11 @@ public Installments getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Installments installments) { @@ -1283,6 +1428,11 @@ public List getLineItems() { } + /** + * Price and product information about the purchased items, to be included on the invoice sent to the shopper. > This field is required for 3x 4x Oney, Affirm, Afterpay, Clearpay, Klarna, Ratepay, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -1316,6 +1466,11 @@ public Map getLocalizedShopperStatement() { } + /** + * The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. + * + * @param localizedShopperStatement + */ @JsonProperty(JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalizedShopperStatement(Map localizedShopperStatement) { @@ -1341,6 +1496,11 @@ public Mandate getMandate() { } + /** + * mandate + * + * @param mandate + */ @JsonProperty(JSON_PROPERTY_MANDATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMandate(Mandate mandate) { @@ -1366,6 +1526,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -1391,6 +1556,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -1416,6 +1586,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -1441,6 +1616,11 @@ public MerchantRiskIndicator getMerchantRiskIndicator() { } + /** + * merchantRiskIndicator + * + * @param merchantRiskIndicator + */ @JsonProperty(JSON_PROPERTY_MERCHANT_RISK_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) { @@ -1474,6 +1654,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -1499,6 +1684,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -1524,6 +1714,11 @@ public EncryptedOrderData getOrder() { } + /** + * order + * + * @param order + */ @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrder(EncryptedOrderData order) { @@ -1549,6 +1744,11 @@ public String getOrderReference() { } + /** + * When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + * + * @param orderReference + */ @JsonProperty(JSON_PROPERTY_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderReference(String orderReference) { @@ -1574,6 +1774,11 @@ public String getOrigin() { } + /** + * Required for the 3D Secure 2 `channel` **Web** integration. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from. + * + * @param origin + */ @JsonProperty(JSON_PROPERTY_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrigin(String origin) { @@ -1599,6 +1804,11 @@ public CheckoutPaymentMethod getPaymentMethod() { } + /** + * paymentMethod + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(CheckoutPaymentMethod paymentMethod) { @@ -1624,6 +1834,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -1649,6 +1864,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -1674,6 +1894,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -1699,6 +1924,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1724,6 +1954,11 @@ public String getRedirectFromIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting back from the issuer. + * + * @param redirectFromIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_FROM_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectFromIssuerMethod(String redirectFromIssuerMethod) { @@ -1749,6 +1984,11 @@ public String getRedirectToIssuerMethod() { } + /** + * Specifies the redirect method (GET or POST) when redirecting to the issuer. + * + * @param redirectToIssuerMethod + */ @JsonProperty(JSON_PROPERTY_REDIRECT_TO_ISSUER_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectToIssuerMethod(String redirectToIssuerMethod) { @@ -1774,6 +2014,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1799,6 +2044,11 @@ public String getReturnUrl() { } + /** + * The URL to return to in case of a redirection. The format depends on the channel. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -1824,6 +2074,11 @@ public RiskData getRiskData() { } + /** + * riskData + * + * @param riskData + */ @JsonProperty(JSON_PROPERTY_RISK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskData(RiskData riskData) { @@ -1849,6 +2104,11 @@ public String getSessionValidity() { } + /** + * The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00 + * + * @param sessionValidity + */ @JsonProperty(JSON_PROPERTY_SESSION_VALIDITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionValidity(String sessionValidity) { @@ -1874,6 +2134,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1899,6 +2164,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1924,6 +2194,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1949,6 +2224,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1974,6 +2254,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1999,6 +2284,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -2024,6 +2314,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -2049,6 +2344,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -2082,6 +2382,11 @@ public List getSplits() { } + /** + * An array of objects specifying how to split a payment when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information), [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic/processing-payments#providing-split-information), or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -2107,6 +2412,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -2132,6 +2442,11 @@ public Boolean getStorePaymentMethod() { } + /** + * When true and `shopperReference` is provided, the payment details will be stored. + * + * @param storePaymentMethod + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethod(Boolean storePaymentMethod) { @@ -2157,6 +2472,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -2182,6 +2502,11 @@ public ThreeDS2RequestFields getThreeDS2RequestData() { } + /** + * threeDS2RequestData + * + * @param threeDS2RequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2RequestData(ThreeDS2RequestFields threeDS2RequestData) { @@ -2209,6 +2534,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -2235,6 +2565,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentResponse.java b/src/main/java/com/adyen/model/checkout/PaymentResponse.java index 31c524e3f..5df15b7e9 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentResponse.java @@ -184,6 +184,11 @@ public PaymentResponseAction getAction() { } + /** + * action + * + * @param action + */ @JsonProperty(JSON_PROPERTY_ACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAction(PaymentResponseAction action) { @@ -217,6 +222,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -242,6 +252,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -267,6 +282,11 @@ public String getDonationToken() { } + /** + * Donation Token containing payment details for Adyen Giving. + * + * @param donationToken + */ @JsonProperty(JSON_PROPERTY_DONATION_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationToken(String donationToken) { @@ -292,6 +312,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -317,6 +342,11 @@ public String getMerchantReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -342,6 +372,11 @@ public CheckoutOrderResponse getOrder() { } + /** + * order + * + * @param order + */ @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrder(CheckoutOrderResponse order) { @@ -367,6 +402,11 @@ public ResponsePaymentMethod getPaymentMethod() { } + /** + * paymentMethod + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(ResponsePaymentMethod paymentMethod) { @@ -392,6 +432,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. > For payment methods that require a redirect or additional action, you will get this value in the `/payments/details` response. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -417,6 +462,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -442,6 +492,11 @@ public String getRefusalReasonCode() { } + /** + * Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReasonCode + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReasonCode(String refusalReasonCode) { @@ -467,6 +522,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -492,6 +552,11 @@ public ThreeDS2ResponseData getThreeDS2ResponseData() { } + /** + * threeDS2ResponseData + * + * @param threeDS2ResponseData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESPONSE_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2ResponseData(ThreeDS2ResponseData threeDS2ResponseData) { @@ -517,6 +582,11 @@ public ThreeDS2Result getThreeDS2Result() { } + /** + * threeDS2Result + * + * @param threeDS2Result + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Result(ThreeDS2Result threeDS2Result) { @@ -542,6 +612,11 @@ public String getThreeDSPaymentData() { } + /** + * When non-empty, contains a value that you must submit to the `/payments/details` endpoint as `paymentData`. + * + * @param threeDSPaymentData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_PAYMENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSPaymentData(String threeDSPaymentData) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentReversalRequest.java b/src/main/java/com/adyen/model/checkout/PaymentReversalRequest.java index 511e22326..2a5455964 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentReversalRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentReversalRequest.java @@ -68,6 +68,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -93,6 +98,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -118,6 +128,11 @@ public String getReference() { } + /** + * Your reference for the reversal request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentReversalResponse.java b/src/main/java/com/adyen/model/checkout/PaymentReversalResponse.java index 9f1186931..59e703953 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentReversalResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentReversalResponse.java @@ -108,6 +108,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -133,6 +138,11 @@ public String getPaymentPspReference() { } + /** + * The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment to reverse. + * + * @param paymentPspReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentPspReference(String paymentPspReference) { @@ -158,6 +168,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the reversal request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -183,6 +198,11 @@ public String getReference() { } + /** + * Your reference for the reversal request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -208,6 +228,11 @@ public StatusEnum getStatus() { } + /** + * The status of your request. This will always have the value **received**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentSetupRequest.java b/src/main/java/com/adyen/model/checkout/PaymentSetupRequest.java index 92586e019..9b3038706 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentSetupRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentSetupRequest.java @@ -409,6 +409,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -442,6 +447,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -475,6 +485,11 @@ public List getAllowedPaymentMethods() { } + /** + * List of payment methods to be presented to the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"allowedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param allowedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_ALLOWED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedPaymentMethods(List allowedPaymentMethods) { @@ -500,6 +515,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -525,6 +545,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -550,6 +575,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -583,6 +613,11 @@ public List getBlockedPaymentMethods() { } + /** + * List of payment methods to be hidden from the shopper. To refer to payment methods, use their [payment method type](https://docs.adyen.com/payment-methods/payment-method-types). Example: `\"blockedPaymentMethods\":[\"ideal\",\"giropay\"]` + * + * @param blockedPaymentMethods + */ @JsonProperty(JSON_PROPERTY_BLOCKED_PAYMENT_METHODS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBlockedPaymentMethods(List blockedPaymentMethods) { @@ -608,6 +643,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -633,6 +673,11 @@ public ChannelEnum getChannel() { } + /** + * The platform where a payment transaction takes place. This field is optional for filtering out payment methods that are only available on specific platforms. If this value is not set, then we will try to infer it from the `sdkVersion` or `token`. Possible values: * iOS * Android * Web + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(ChannelEnum channel) { @@ -658,6 +703,11 @@ public String getCheckoutAttemptId() { } + /** + * Checkout attempt ID that corresponds to the Id generated by the client SDK for tracking user payment journey. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -683,6 +733,11 @@ public Company getCompany() { } + /** + * company + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(Company company) { @@ -708,6 +763,11 @@ public ModelConfiguration getConfiguration() { } + /** + * configuration + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(ModelConfiguration configuration) { @@ -735,6 +795,11 @@ public String getConversionId() { } + /** + * Conversion ID that corresponds to the Id generated by the client SDK for tracking user payment journey. + * + * @param conversionId + */ @Deprecated @JsonProperty(JSON_PROPERTY_CONVERSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -761,6 +826,11 @@ public String getCountryCode() { } + /** + * The shopper country. Format: [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) Example: NL or DE + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -786,6 +856,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -811,6 +886,11 @@ public ForexQuote getDccQuote() { } + /** + * dccQuote + * + * @param dccQuote + */ @JsonProperty(JSON_PROPERTY_DCC_QUOTE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccQuote(ForexQuote dccQuote) { @@ -836,6 +916,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -861,6 +946,11 @@ public OffsetDateTime getDeliveryDate() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliveryDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryDate(OffsetDateTime deliveryDate) { @@ -886,6 +976,11 @@ public Boolean getEnableOneClick() { } + /** + * When true and `shopperReference` is provided, the shopper will be asked if the payment details should be stored for future one-click payments. + * + * @param enableOneClick + */ @JsonProperty(JSON_PROPERTY_ENABLE_ONE_CLICK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableOneClick(Boolean enableOneClick) { @@ -911,6 +1006,11 @@ public Boolean getEnablePayOut() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for payouts. + * + * @param enablePayOut + */ @JsonProperty(JSON_PROPERTY_ENABLE_PAY_OUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnablePayOut(Boolean enablePayOut) { @@ -936,6 +1036,11 @@ public Boolean getEnableRecurring() { } + /** + * When true and `shopperReference` is provided, the payment details will be tokenized for recurring payments. + * + * @param enableRecurring + */ @JsonProperty(JSON_PROPERTY_ENABLE_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableRecurring(Boolean enableRecurring) { @@ -961,6 +1066,11 @@ public EntityTypeEnum getEntityType() { } + /** + * The type of the entity the payment is processed for. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(EntityTypeEnum entityType) { @@ -986,6 +1096,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -1011,6 +1126,11 @@ public Installments getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Installments installments) { @@ -1044,6 +1164,11 @@ public List getLineItems() { } + /** + * Price and product information of the refunded items, required for [partial refunds](https://docs.adyen.com/online-payments/refund#refund-a-payment). > This field is required for partial refunds with 3x 4x Oney, Affirm, Afterpay, Atome, Clearpay, Klarna, Ratepay, Walley, and Zip. + * + * @param lineItems + */ @JsonProperty(JSON_PROPERTY_LINE_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLineItems(List lineItems) { @@ -1077,6 +1202,11 @@ public Map getLocalizedShopperStatement() { } + /** + * The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. + * + * @param localizedShopperStatement + */ @JsonProperty(JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalizedShopperStatement(Map localizedShopperStatement) { @@ -1102,6 +1232,11 @@ public Mandate getMandate() { } + /** + * mandate + * + * @param mandate + */ @JsonProperty(JSON_PROPERTY_MANDATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMandate(Mandate mandate) { @@ -1127,6 +1262,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -1152,6 +1292,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -1177,6 +1322,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -1210,6 +1360,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -1235,6 +1390,11 @@ public String getOrderReference() { } + /** + * When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + * + * @param orderReference + */ @JsonProperty(JSON_PROPERTY_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderReference(String orderReference) { @@ -1260,6 +1420,11 @@ public String getOrigin() { } + /** + * Required for the Web integration. Set this parameter to the origin URL of the page that you are loading the SDK from. + * + * @param origin + */ @JsonProperty(JSON_PROPERTY_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrigin(String origin) { @@ -1285,6 +1450,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -1310,6 +1480,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -1335,6 +1510,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -1360,6 +1540,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1385,6 +1570,11 @@ public String getReturnUrl() { } + /** + * The URL to return to in case of a redirection. The format depends on the channel. This URL can have a maximum of 1024 characters. * For web, include the protocol `http://` or `https://`. You can also include your own additional query parameters, for example, shopper ID or order reference number. Example: `https://your-company.com/checkout?shopperOrder=12xy` * For iOS, use the custom URL for your app. To know more about setting custom URL schemes, refer to the [Apple Developer documentation](https://developer.apple.com/documentation/uikit/inter-process_communication/allowing_apps_and_websites_to_link_to_your_content/defining_a_custom_url_scheme_for_your_app). Example: `my-app://` * For Android, use a custom URL handled by an Activity on your app. You can configure it with an [intent filter](https://developer.android.com/guide/components/intents-filters). Example: `my-app://your.package.name` + * + * @param returnUrl + */ @JsonProperty(JSON_PROPERTY_RETURN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReturnUrl(String returnUrl) { @@ -1410,6 +1600,11 @@ public RiskData getRiskData() { } + /** + * riskData + * + * @param riskData + */ @JsonProperty(JSON_PROPERTY_RISK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskData(RiskData riskData) { @@ -1435,6 +1630,11 @@ public String getSdkVersion() { } + /** + * The version of the SDK you are using (for Web SDK integrations only). + * + * @param sdkVersion + */ @JsonProperty(JSON_PROPERTY_SDK_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkVersion(String sdkVersion) { @@ -1460,6 +1660,11 @@ public String getSessionValidity() { } + /** + * The date and time until when the session remains valid, in [ISO 8601](https://www.w3.org/TR/NOTE-datetime) format. For example: 2020-07-18T15:42:40.428+01:00 + * + * @param sessionValidity + */ @JsonProperty(JSON_PROPERTY_SESSION_VALIDITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionValidity(String sessionValidity) { @@ -1485,6 +1690,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1510,6 +1720,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1535,6 +1750,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1560,6 +1780,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1585,6 +1810,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1610,6 +1840,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1635,6 +1870,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1660,6 +1900,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1693,6 +1938,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1718,6 +1968,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1743,6 +1998,11 @@ public Boolean getStorePaymentMethod() { } + /** + * When true and `shopperReference` is provided, the payment details will be stored. + * + * @param storePaymentMethod + */ @JsonProperty(JSON_PROPERTY_STORE_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStorePaymentMethod(Boolean storePaymentMethod) { @@ -1768,6 +2028,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1795,6 +2060,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -1821,6 +2091,11 @@ public String getToken() { } + /** + * The token obtained when initializing the SDK. > This parameter is required for iOS and Android; not required for Web. + * + * @param token + */ @JsonProperty(JSON_PROPERTY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToken(String token) { @@ -1846,6 +2121,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentSetupResponse.java b/src/main/java/com/adyen/model/checkout/PaymentSetupResponse.java index eb810c407..9df2039ee 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentSetupResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentSetupResponse.java @@ -66,6 +66,11 @@ public String getPaymentSession() { } + /** + * The encoded payment session that you need to pass to the SDK. + * + * @param paymentSession + */ @JsonProperty(JSON_PROPERTY_PAYMENT_SESSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentSession(String paymentSession) { @@ -101,6 +106,11 @@ public List getRecurringDetails() { } + /** + * The detailed list of stored payment details required to generate payment forms. Will be empty if oneClick is set to false in the request. + * + * @param recurringDetails + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/src/main/java/com/adyen/model/checkout/PaymentVerificationRequest.java b/src/main/java/com/adyen/model/checkout/PaymentVerificationRequest.java index 09de40bd0..828256dd1 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentVerificationRequest.java +++ b/src/main/java/com/adyen/model/checkout/PaymentVerificationRequest.java @@ -59,6 +59,11 @@ public String getPayload() { } + /** + * Encrypted and signed payment result data. You should receive this value from the Checkout SDK after the shopper completes the payment. + * + * @param payload + */ @JsonProperty(JSON_PROPERTY_PAYLOAD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayload(String payload) { diff --git a/src/main/java/com/adyen/model/checkout/PaymentVerificationResponse.java b/src/main/java/com/adyen/model/checkout/PaymentVerificationResponse.java index cb3e1646b..16c4aa7c2 100644 --- a/src/main/java/com/adyen/model/checkout/PaymentVerificationResponse.java +++ b/src/main/java/com/adyen/model/checkout/PaymentVerificationResponse.java @@ -168,6 +168,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -193,6 +198,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -218,6 +228,11 @@ public String getMerchantReference() { } + /** + * A unique value that you provided in the initial `/paymentSession` request as a `reference` field. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -243,6 +258,11 @@ public CheckoutOrderResponse getOrder() { } + /** + * order + * + * @param order + */ @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrder(CheckoutOrderResponse order) { @@ -268,6 +288,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -293,6 +318,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -318,6 +348,11 @@ public String getRefusalReasonCode() { } + /** + * Code that specifies the refusal reason. For more information, see [Authorisation refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReasonCode + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReasonCode(String refusalReasonCode) { @@ -343,6 +378,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -368,6 +408,11 @@ public ServiceErrorDetails getServiceError() { } + /** + * serviceError + * + * @param serviceError + */ @JsonProperty(JSON_PROPERTY_SERVICE_ERROR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setServiceError(ServiceErrorDetails serviceError) { @@ -393,6 +438,11 @@ public String getShopperLocale() { } + /** + * The shopperLocale value provided in the payment request. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { diff --git a/src/main/java/com/adyen/model/checkout/Phone.java b/src/main/java/com/adyen/model/checkout/Phone.java index e27e577f4..1ef24b9f5 100644 --- a/src/main/java/com/adyen/model/checkout/Phone.java +++ b/src/main/java/com/adyen/model/checkout/Phone.java @@ -63,6 +63,11 @@ public String getCc() { } + /** + * Country code. Length: 1–3 characters. + * + * @param cc + */ @JsonProperty(JSON_PROPERTY_CC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCc(String cc) { @@ -88,6 +93,11 @@ public String getSubscriber() { } + /** + * Subscriber number. Maximum length: 15 characters. + * + * @param subscriber + */ @JsonProperty(JSON_PROPERTY_SUBSCRIBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubscriber(String subscriber) { diff --git a/src/main/java/com/adyen/model/checkout/PlatformChargebackLogic.java b/src/main/java/com/adyen/model/checkout/PlatformChargebackLogic.java index 3f303d887..a894e3f93 100644 --- a/src/main/java/com/adyen/model/checkout/PlatformChargebackLogic.java +++ b/src/main/java/com/adyen/model/checkout/PlatformChargebackLogic.java @@ -104,6 +104,11 @@ public BehaviorEnum getBehavior() { } + /** + * The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. + * + * @param behavior + */ @JsonProperty(JSON_PROPERTY_BEHAVIOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBehavior(BehaviorEnum behavior) { @@ -129,6 +134,11 @@ public String getCostAllocationAccount() { } + /** + * The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. + * + * @param costAllocationAccount + */ @JsonProperty(JSON_PROPERTY_COST_ALLOCATION_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCostAllocationAccount(String costAllocationAccount) { @@ -154,6 +164,11 @@ public String getTargetAccount() { } + /** + * The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. + * + * @param targetAccount + */ @JsonProperty(JSON_PROPERTY_TARGET_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTargetAccount(String targetAccount) { diff --git a/src/main/java/com/adyen/model/checkout/RatepayDetails.java b/src/main/java/com/adyen/model/checkout/RatepayDetails.java index 6f05b730e..1fd41ce84 100644 --- a/src/main/java/com/adyen/model/checkout/RatepayDetails.java +++ b/src/main/java/com/adyen/model/checkout/RatepayDetails.java @@ -118,6 +118,11 @@ public String getBillingAddress() { } + /** + * The address where to send the invoice. + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(String billingAddress) { @@ -143,6 +148,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -168,6 +178,11 @@ public String getDeliveryAddress() { } + /** + * The address where the goods should be delivered. + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(String deliveryAddress) { @@ -193,6 +208,11 @@ public String getPersonalDetails() { } + /** + * Shopper name, date of birth, phone number, and email address. + * + * @param personalDetails + */ @JsonProperty(JSON_PROPERTY_PERSONAL_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPersonalDetails(String personalDetails) { @@ -220,6 +240,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -246,6 +271,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -271,6 +301,11 @@ public TypeEnum getType() { } + /** + * **ratepay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/Recurring.java b/src/main/java/com/adyen/model/checkout/Recurring.java index 73f5531b4..08073e686 100644 --- a/src/main/java/com/adyen/model/checkout/Recurring.java +++ b/src/main/java/com/adyen/model/checkout/Recurring.java @@ -152,6 +152,11 @@ public ContractEnum getContract() { } + /** + * The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts). + * + * @param contract + */ @JsonProperty(JSON_PROPERTY_CONTRACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContract(ContractEnum contract) { @@ -177,6 +182,11 @@ public String getRecurringDetailName() { } + /** + * A descriptive name for this detail. + * + * @param recurringDetailName + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailName(String recurringDetailName) { @@ -202,6 +212,11 @@ public OffsetDateTime getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(OffsetDateTime recurringExpiry) { @@ -227,6 +242,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -252,6 +272,11 @@ public TokenServiceEnum getTokenService() { } + /** + * The name of the token service. + * + * @param tokenService + */ @JsonProperty(JSON_PROPERTY_TOKEN_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenService(TokenServiceEnum tokenService) { diff --git a/src/main/java/com/adyen/model/checkout/RecurringDetail.java b/src/main/java/com/adyen/model/checkout/RecurringDetail.java index 2f5532065..28b250c8e 100644 --- a/src/main/java/com/adyen/model/checkout/RecurringDetail.java +++ b/src/main/java/com/adyen/model/checkout/RecurringDetail.java @@ -142,6 +142,11 @@ public String getBrand() { } + /** + * Brand for the selected gift card. For example: plastix, hmclub. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -175,6 +180,11 @@ public List getBrands() { } + /** + * List of possible brands. For example: visa, mc. + * + * @param brands + */ @JsonProperty(JSON_PROPERTY_BRANDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrands(List brands) { @@ -208,6 +218,11 @@ public Map getConfiguration() { } + /** + * The configuration of the payment method. + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(Map configuration) { @@ -233,6 +248,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source of the payment method. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -258,6 +278,11 @@ public PaymentMethodGroup getGroup() { } + /** + * group + * + * @param group + */ @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGroup(PaymentMethodGroup group) { @@ -293,6 +318,11 @@ public List getInputDetails() { } + /** + * All input details to be provided to complete the payment with this payment method. + * + * @param inputDetails + */ @Deprecated @JsonProperty(JSON_PROPERTY_INPUT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -327,6 +357,11 @@ public List getIssuers() { } + /** + * A list of issuers for this payment method. + * + * @param issuers + */ @JsonProperty(JSON_PROPERTY_ISSUERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuers(List issuers) { @@ -352,6 +387,11 @@ public String getName() { } + /** + * The displayable name of this payment method. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -377,6 +417,11 @@ public String getRecurringDetailReference() { } + /** + * The reference that uniquely identifies the recurring detail. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -402,6 +447,11 @@ public StoredDetails getStoredDetails() { } + /** + * storedDetails + * + * @param storedDetails + */ @JsonProperty(JSON_PROPERTY_STORED_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredDetails(StoredDetails storedDetails) { @@ -427,6 +477,11 @@ public String getType() { } + /** + * The unique payment method code. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalData3DSecure.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalData3DSecure.java index cc6522c0d..3a57f123e 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalData3DSecure.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalData3DSecure.java @@ -75,6 +75,11 @@ public String getCardHolderInfo() { } + /** + * Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. + * + * @param cardHolderInfo + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderInfo(String cardHolderInfo) { @@ -100,6 +105,11 @@ public String getCavv() { } + /** + * The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array. + * + * @param cavv + */ @JsonProperty(JSON_PROPERTY_CAVV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavv(String cavv) { @@ -125,6 +135,11 @@ public String getCavvAlgorithm() { } + /** + * The CAVV algorithm used. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -150,6 +165,11 @@ public String getScaExemptionRequested() { } + /** + * Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + * + * @param scaExemptionRequested + */ @JsonProperty(JSON_PROPERTY_SCA_EXEMPTION_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScaExemptionRequested(String scaExemptionRequested) { @@ -175,6 +195,11 @@ public Boolean getThreeds2CardEnrolled() { } + /** + * Indicates whether a card is enrolled for 3D Secure 2. + * + * @param threeds2CardEnrolled + */ @JsonProperty(JSON_PROPERTY_THREEDS2_CARD_ENROLLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeds2CardEnrolled(Boolean threeds2CardEnrolled) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataBillingAddress.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataBillingAddress.java index 0ec699653..12c9c07cb 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataBillingAddress.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataBillingAddress.java @@ -79,6 +79,11 @@ public String getBillingAddressCity() { } + /** + * The billing address city passed in the payment request. + * + * @param billingAddressCity + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressCity(String billingAddressCity) { @@ -104,6 +109,11 @@ public String getBillingAddressCountry() { } + /** + * The billing address country passed in the payment request. Example: NL + * + * @param billingAddressCountry + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressCountry(String billingAddressCountry) { @@ -129,6 +139,11 @@ public String getBillingAddressHouseNumberOrName() { } + /** + * The billing address house number or name passed in the payment request. + * + * @param billingAddressHouseNumberOrName + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressHouseNumberOrName(String billingAddressHouseNumberOrName) { @@ -154,6 +169,11 @@ public String getBillingAddressPostalCode() { } + /** + * The billing address postal code passed in the payment request. Example: 1011 DJ + * + * @param billingAddressPostalCode + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressPostalCode(String billingAddressPostalCode) { @@ -179,6 +199,11 @@ public String getBillingAddressStateOrProvince() { } + /** + * The billing address state or province passed in the payment request. Example: NH + * + * @param billingAddressStateOrProvince + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressStateOrProvince(String billingAddressStateOrProvince) { @@ -204,6 +229,11 @@ public String getBillingAddressStreet() { } + /** + * The billing address street passed in the payment request. + * + * @param billingAddressStreet + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressStreet(String billingAddressStreet) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCard.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCard.java index bbbee1d58..03a6e0a56 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCard.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCard.java @@ -87,6 +87,11 @@ public String getCardBin() { } + /** + * The first six digits of the card number. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN. Example: 521234 + * + * @param cardBin + */ @JsonProperty(JSON_PROPERTY_CARD_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardBin(String cardBin) { @@ -112,6 +117,11 @@ public String getCardHolderName() { } + /** + * The cardholder name passed in the payment request. + * + * @param cardHolderName + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderName(String cardHolderName) { @@ -137,6 +147,11 @@ public String getCardIssuingBank() { } + /** + * The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available. + * + * @param cardIssuingBank + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingBank(String cardIssuingBank) { @@ -162,6 +177,11 @@ public String getCardIssuingCountry() { } + /** + * The country where the card was issued. Example: US + * + * @param cardIssuingCountry + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingCountry(String cardIssuingCountry) { @@ -187,6 +207,11 @@ public String getCardIssuingCurrency() { } + /** + * The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. Example: USD + * + * @param cardIssuingCurrency + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingCurrency(String cardIssuingCurrency) { @@ -212,6 +237,11 @@ public String getCardPaymentMethod() { } + /** + * The card payment method used for the transaction. Example: amex + * + * @param cardPaymentMethod + */ @JsonProperty(JSON_PROPERTY_CARD_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardPaymentMethod(String cardPaymentMethod) { @@ -237,6 +267,11 @@ public String getCardSummary() { } + /** + * The last four digits of a card number. > Returned only in case of a card payment. + * + * @param cardSummary + */ @JsonProperty(JSON_PROPERTY_CARD_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardSummary(String cardSummary) { @@ -262,6 +297,11 @@ public String getIssuerBin() { } + /** + * The first eight digits of the card number. Only returned if the card number is 16 digits or more. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN. Example: 52123423 + * + * @param issuerBin + */ @JsonProperty(JSON_PROPERTY_ISSUER_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerBin(String issuerBin) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCommon.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCommon.java index 2601bc91f..03e9a8b5a 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCommon.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataCommon.java @@ -363,6 +363,11 @@ public String getAcquirerAccountCode() { } + /** + * The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. + * + * @param acquirerAccountCode + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerAccountCode(String acquirerAccountCode) { @@ -388,6 +393,11 @@ public String getAcquirerCode() { } + /** + * The name of the acquirer processing the payment request. Example: TestPmmAcquirer + * + * @param acquirerCode + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerCode(String acquirerCode) { @@ -413,6 +423,11 @@ public String getAcquirerReference() { } + /** + * The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9 + * + * @param acquirerReference + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerReference(String acquirerReference) { @@ -438,6 +453,11 @@ public String getAlias() { } + /** + * The Adyen alias of the card. Example: H167852639363479 + * + * @param alias + */ @JsonProperty(JSON_PROPERTY_ALIAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlias(String alias) { @@ -463,6 +483,11 @@ public String getAliasType() { } + /** + * The type of the card alias. Example: Default + * + * @param aliasType + */ @JsonProperty(JSON_PROPERTY_ALIAS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAliasType(String aliasType) { @@ -488,6 +513,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. Example: 58747 + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -513,6 +543,11 @@ public String getAuthorisationMid() { } + /** + * Merchant ID known by the acquirer. + * + * @param authorisationMid + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_MID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationMid(String authorisationMid) { @@ -538,6 +573,11 @@ public String getAuthorisedAmountCurrency() { } + /** + * The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param authorisedAmountCurrency + */ @JsonProperty(JSON_PROPERTY_AUTHORISED_AMOUNT_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisedAmountCurrency(String authorisedAmountCurrency) { @@ -563,6 +603,11 @@ public String getAuthorisedAmountValue() { } + /** + * Value of the amount authorised. This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + * + * @param authorisedAmountValue + */ @JsonProperty(JSON_PROPERTY_AUTHORISED_AMOUNT_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisedAmountValue(String authorisedAmountValue) { @@ -588,6 +633,11 @@ public String getAvsResult() { } + /** + * The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + * + * @param avsResult + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResult(String avsResult) { @@ -613,6 +663,11 @@ public String getAvsResultRaw() { } + /** + * Raw AVS result received from the acquirer, where available. Example: D + * + * @param avsResultRaw + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResultRaw(String avsResultRaw) { @@ -638,6 +693,11 @@ public String getBic() { } + /** + * BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -663,6 +723,11 @@ public String getCoBrandedWith() { } + /** + * Includes the co-branded card information. + * + * @param coBrandedWith + */ @JsonProperty(JSON_PROPERTY_CO_BRANDED_WITH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCoBrandedWith(String coBrandedWith) { @@ -688,6 +753,11 @@ public String getCvcResult() { } + /** + * The result of CVC verification. + * + * @param cvcResult + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResult(String cvcResult) { @@ -713,6 +783,11 @@ public String getCvcResultRaw() { } + /** + * The raw result of CVC verification. + * + * @param cvcResultRaw + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResultRaw(String cvcResultRaw) { @@ -738,6 +813,11 @@ public String getDsTransID() { } + /** + * Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -763,6 +843,11 @@ public String getEci() { } + /** + * The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02 + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -788,6 +873,11 @@ public String getExpiryDate() { } + /** + * The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. + * + * @param expiryDate + */ @JsonProperty(JSON_PROPERTY_EXPIRY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryDate(String expiryDate) { @@ -813,6 +903,11 @@ public String getExtraCostsCurrency() { } + /** + * The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR + * + * @param extraCostsCurrency + */ @JsonProperty(JSON_PROPERTY_EXTRA_COSTS_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtraCostsCurrency(String extraCostsCurrency) { @@ -838,6 +933,11 @@ public String getExtraCostsValue() { } + /** + * The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units. + * + * @param extraCostsValue + */ @JsonProperty(JSON_PROPERTY_EXTRA_COSTS_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtraCostsValue(String extraCostsValue) { @@ -863,6 +963,11 @@ public String getFraudCheckItemNrFraudCheckname() { } + /** + * The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. + * + * @param fraudCheckItemNrFraudCheckname + */ @JsonProperty(JSON_PROPERTY_FRAUD_CHECK_ITEM_NR_FRAUD_CHECKNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudCheckItemNrFraudCheckname(String fraudCheckItemNrFraudCheckname) { @@ -888,6 +993,11 @@ public String getFraudManualReview() { } + /** + * Indicates if the payment is sent to manual review. + * + * @param fraudManualReview + */ @JsonProperty(JSON_PROPERTY_FRAUD_MANUAL_REVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudManualReview(String fraudManualReview) { @@ -913,6 +1023,11 @@ public FraudResultTypeEnum getFraudResultType() { } + /** + * The fraud result properties of the payment. + * + * @param fraudResultType + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResultType(FraudResultTypeEnum fraudResultType) { @@ -938,6 +1053,11 @@ public String getFundingSource() { } + /** + * Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(String fundingSource) { @@ -963,6 +1083,11 @@ public String getFundsAvailability() { } + /** + * Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\". + * + * @param fundsAvailability + */ @JsonProperty(JSON_PROPERTY_FUNDS_AVAILABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundsAvailability(String fundsAvailability) { @@ -988,6 +1113,11 @@ public String getInferredRefusalReason() { } + /** + * Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card + * + * @param inferredRefusalReason + */ @JsonProperty(JSON_PROPERTY_INFERRED_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInferredRefusalReason(String inferredRefusalReason) { @@ -1013,6 +1143,11 @@ public String getIsCardCommercial() { } + /** + * Indicates if the card is used for business purposes only. + * + * @param isCardCommercial + */ @JsonProperty(JSON_PROPERTY_IS_CARD_COMMERCIAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCardCommercial(String isCardCommercial) { @@ -1038,6 +1173,11 @@ public String getIssuerCountry() { } + /** + * The issuing country of the card based on the BIN list that Adyen maintains. Example: JP + * + * @param issuerCountry + */ @JsonProperty(JSON_PROPERTY_ISSUER_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerCountry(String issuerCountry) { @@ -1063,6 +1203,11 @@ public String getLiabilityShift() { } + /** + * A Boolean value indicating whether a liability shift was offered for this payment. + * + * @param liabilityShift + */ @JsonProperty(JSON_PROPERTY_LIABILITY_SHIFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLiabilityShift(String liabilityShift) { @@ -1088,6 +1233,11 @@ public String getMcBankNetReferenceNumber() { } + /** + * The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. + * + * @param mcBankNetReferenceNumber + */ @JsonProperty(JSON_PROPERTY_MC_BANK_NET_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcBankNetReferenceNumber(String mcBankNetReferenceNumber) { @@ -1113,6 +1263,11 @@ public String getMerchantAdviceCode() { } + /** + * The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes). + * + * @param merchantAdviceCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ADVICE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAdviceCode(String merchantAdviceCode) { @@ -1138,6 +1293,11 @@ public String getMerchantReference() { } + /** + * The reference provided for the transaction. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -1163,6 +1323,11 @@ public String getNetworkTxReference() { } + /** + * Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -1188,6 +1353,11 @@ public String getOwnerName() { } + /** + * The owner name of a bank account. Only relevant for SEPA Direct Debit transactions. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -1213,6 +1383,11 @@ public String getPaymentAccountReference() { } + /** + * The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters. + * + * @param paymentAccountReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountReference(String paymentAccountReference) { @@ -1238,6 +1413,11 @@ public String getPaymentMethod() { } + /** + * The payment method used in the transaction. + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -1263,6 +1443,11 @@ public String getPaymentMethodVariant() { } + /** + * The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro + * + * @param paymentMethodVariant + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodVariant(String paymentMethodVariant) { @@ -1288,6 +1473,11 @@ public String getPayoutEligible() { } + /** + * Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) + * + * @param payoutEligible + */ @JsonProperty(JSON_PROPERTY_PAYOUT_ELIGIBLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayoutEligible(String payoutEligible) { @@ -1313,6 +1503,11 @@ public String getRealtimeAccountUpdaterStatus() { } + /** + * The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder + * + * @param realtimeAccountUpdaterStatus + */ @JsonProperty(JSON_PROPERTY_REALTIME_ACCOUNT_UPDATER_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRealtimeAccountUpdaterStatus(String realtimeAccountUpdaterStatus) { @@ -1338,6 +1533,11 @@ public String getReceiptFreeText() { } + /** + * Message to be displayed on the terminal. + * + * @param receiptFreeText + */ @JsonProperty(JSON_PROPERTY_RECEIPT_FREE_TEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceiptFreeText(String receiptFreeText) { @@ -1363,6 +1563,11 @@ public String getRecurringContractTypes() { } + /** + * The recurring contract types applicable to the transaction. + * + * @param recurringContractTypes + */ @JsonProperty(JSON_PROPERTY_RECURRING_CONTRACT_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringContractTypes(String recurringContractTypes) { @@ -1388,6 +1593,11 @@ public String getRecurringFirstPspReference() { } + /** + * The `pspReference`, of the first recurring payment that created the recurring detail. This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + * + * @param recurringFirstPspReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_FIRST_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFirstPspReference(String recurringFirstPspReference) { @@ -1413,6 +1623,11 @@ public String getRecurringRecurringDetailReference() { } + /** + * The reference that uniquely identifies the recurring transaction. + * + * @param recurringRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringRecurringDetailReference(String recurringRecurringDetailReference) { @@ -1438,6 +1653,11 @@ public String getRecurringShopperReference() { } + /** + * The provided reference of the shopper for a recurring transaction. + * + * @param recurringShopperReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringShopperReference(String recurringShopperReference) { @@ -1463,6 +1683,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * The processing model used for the recurring transaction. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1488,6 +1713,11 @@ public String getReferred() { } + /** + * If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true + * + * @param referred + */ @JsonProperty(JSON_PROPERTY_REFERRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReferred(String referred) { @@ -1513,6 +1743,11 @@ public String getRefusalReasonRaw() { } + /** + * Raw refusal reason received from the acquirer, where available. Example: AUTHORISED + * + * @param refusalReasonRaw + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReasonRaw(String refusalReasonRaw) { @@ -1538,6 +1773,11 @@ public String getRequestAmount() { } + /** + * The amount of the payment request. + * + * @param requestAmount + */ @JsonProperty(JSON_PROPERTY_REQUEST_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestAmount(String requestAmount) { @@ -1563,6 +1803,11 @@ public String getRequestCurrencyCode() { } + /** + * The currency of the payment request. + * + * @param requestCurrencyCode + */ @JsonProperty(JSON_PROPERTY_REQUEST_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestCurrencyCode(String requestCurrencyCode) { @@ -1588,6 +1833,11 @@ public String getShopperInteraction() { } + /** + * The shopper interaction type of the payment request. Example: Ecommerce + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(String shopperInteraction) { @@ -1613,6 +1863,11 @@ public String getShopperReference() { } + /** + * The shopperReference passed in the payment request. Example: AdyenTestShopperXX + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1638,6 +1893,11 @@ public String getTerminalId() { } + /** + * The terminal ID used in a point-of-sale payment. Example: 06022622 + * + * @param terminalId + */ @JsonProperty(JSON_PROPERTY_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalId(String terminalId) { @@ -1663,6 +1923,11 @@ public String getThreeDAuthenticated() { } + /** + * A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true + * + * @param threeDAuthenticated + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticated(String threeDAuthenticated) { @@ -1688,6 +1953,11 @@ public String getThreeDAuthenticatedResponse() { } + /** + * The raw 3DS authentication result from the card issuer. Example: N + * + * @param threeDAuthenticatedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticatedResponse(String threeDAuthenticatedResponse) { @@ -1713,6 +1983,11 @@ public String getThreeDOffered() { } + /** + * A Boolean value indicating whether 3DS was offered for this payment. Example: true + * + * @param threeDOffered + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOffered(String threeDOffered) { @@ -1738,6 +2013,11 @@ public String getThreeDOfferedResponse() { } + /** + * The raw enrollment result from the 3DS directory services of the card schemes. Example: Y + * + * @param threeDOfferedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOfferedResponse(String threeDOfferedResponse) { @@ -1763,6 +2043,11 @@ public String getThreeDSVersion() { } + /** + * The 3D Secure 2 version. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { @@ -1788,6 +2073,11 @@ public String getVisaTransactionId() { } + /** + * The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. + * + * @param visaTransactionId + */ @JsonProperty(JSON_PROPERTY_VISA_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisaTransactionId(String visaTransactionId) { @@ -1813,6 +2103,11 @@ public String getXid() { } + /** + * The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + * + * @param xid + */ @JsonProperty(JSON_PROPERTY_XID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setXid(String xid) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataDomesticError.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataDomesticError.java index 711c940e6..068cb95e5 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataDomesticError.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataDomesticError.java @@ -63,6 +63,11 @@ public String getDomesticRefusalReasonRaw() { } + /** + * The reason the transaction was declined, given by the local issuer. Currently available for merchants in Japan. + * + * @param domesticRefusalReasonRaw + */ @JsonProperty(JSON_PROPERTY_DOMESTIC_REFUSAL_REASON_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomesticRefusalReasonRaw(String domesticRefusalReasonRaw) { @@ -88,6 +93,11 @@ public String getDomesticShopperAdvice() { } + /** + * The action the shopper should take, in a local language. Currently available in Japanese, for merchants in Japan. + * + * @param domesticShopperAdvice + */ @JsonProperty(JSON_PROPERTY_DOMESTIC_SHOPPER_ADVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomesticShopperAdvice(String domesticShopperAdvice) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataInstallments.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataInstallments.java index dfac10a9e..86447199a 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataInstallments.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataInstallments.java @@ -103,6 +103,11 @@ public String getInstallmentPaymentDataInstallmentType() { } + /** + * Type of installment. The value of `installmentType` should be **IssuerFinanced**. + * + * @param installmentPaymentDataInstallmentType + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_INSTALLMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataInstallmentType(String installmentPaymentDataInstallmentType) { @@ -128,6 +133,11 @@ public String getInstallmentPaymentDataOptionItemNrAnnualPercentageRate() { } + /** + * Annual interest rate. + * + * @param installmentPaymentDataOptionItemNrAnnualPercentageRate + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_ANNUAL_PERCENTAGE_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrAnnualPercentageRate(String installmentPaymentDataOptionItemNrAnnualPercentageRate) { @@ -153,6 +163,11 @@ public String getInstallmentPaymentDataOptionItemNrFirstInstallmentAmount() { } + /** + * First Installment Amount in minor units. + * + * @param installmentPaymentDataOptionItemNrFirstInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_FIRST_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrFirstInstallmentAmount(String installmentPaymentDataOptionItemNrFirstInstallmentAmount) { @@ -178,6 +193,11 @@ public String getInstallmentPaymentDataOptionItemNrInstallmentFee() { } + /** + * Installment fee amount in minor units. + * + * @param installmentPaymentDataOptionItemNrInstallmentFee + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_INSTALLMENT_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrInstallmentFee(String installmentPaymentDataOptionItemNrInstallmentFee) { @@ -203,6 +223,11 @@ public String getInstallmentPaymentDataOptionItemNrInterestRate() { } + /** + * Interest rate for the installment period. + * + * @param installmentPaymentDataOptionItemNrInterestRate + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_INTEREST_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrInterestRate(String installmentPaymentDataOptionItemNrInterestRate) { @@ -228,6 +253,11 @@ public String getInstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments() } + /** + * Maximum number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrMaximumNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_MAXIMUM_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments(String installmentPaymentDataOptionItemNrMaximumNumberOfInstallments) { @@ -253,6 +283,11 @@ public String getInstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments() } + /** + * Minimum number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrMinimumNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_MINIMUM_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments(String installmentPaymentDataOptionItemNrMinimumNumberOfInstallments) { @@ -278,6 +313,11 @@ public String getInstallmentPaymentDataOptionItemNrNumberOfInstallments() { } + /** + * Total number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrNumberOfInstallments(String installmentPaymentDataOptionItemNrNumberOfInstallments) { @@ -303,6 +343,11 @@ public String getInstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount() } + /** + * Subsequent Installment Amount in minor units. + * + * @param installmentPaymentDataOptionItemNrSubsequentInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_SUBSEQUENT_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount(String installmentPaymentDataOptionItemNrSubsequentInstallmentAmount) { @@ -328,6 +373,11 @@ public String getInstallmentPaymentDataOptionItemNrTotalAmountDue() { } + /** + * Total amount in minor units. + * + * @param installmentPaymentDataOptionItemNrTotalAmountDue + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_TOTAL_AMOUNT_DUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrTotalAmountDue(String installmentPaymentDataOptionItemNrTotalAmountDue) { @@ -353,6 +403,11 @@ public String getInstallmentPaymentDataPaymentOptions() { } + /** + * Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments + * + * @param installmentPaymentDataPaymentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_PAYMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataPaymentOptions(String installmentPaymentDataPaymentOptions) { @@ -378,6 +433,11 @@ public String getInstallmentsValue() { } + /** + * The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. + * + * @param installmentsValue + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentsValue(String installmentsValue) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataNetworkTokens.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataNetworkTokens.java index 9a2555501..64099fce4 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataNetworkTokens.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataNetworkTokens.java @@ -67,6 +67,11 @@ public String getNetworkTokenAvailable() { } + /** + * Indicates whether a network token is available for the specified card. + * + * @param networkTokenAvailable + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_AVAILABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenAvailable(String networkTokenAvailable) { @@ -92,6 +97,11 @@ public String getNetworkTokenBin() { } + /** + * The Bank Identification Number of a tokenized card, which is the first six digits of a card number. + * + * @param networkTokenBin + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenBin(String networkTokenBin) { @@ -117,6 +127,11 @@ public String getNetworkTokenTokenSummary() { } + /** + * The last four digits of a network token. + * + * @param networkTokenTokenSummary + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_TOKEN_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenTokenSummary(String networkTokenTokenSummary) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataOpi.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataOpi.java index 7b9c8354a..075215b6f 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataOpi.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataOpi.java @@ -59,6 +59,11 @@ public String getOpiTransToken() { } + /** + * Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + * + * @param opiTransToken + */ @JsonProperty(JSON_PROPERTY_OPI_TRANS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpiTransToken(String opiTransToken) { diff --git a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataSepa.java b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataSepa.java index 6fb783bd8..778dbf4c7 100644 --- a/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataSepa.java +++ b/src/main/java/com/adyen/model/checkout/ResponseAdditionalDataSepa.java @@ -67,6 +67,11 @@ public String getSepadirectdebitDateOfSignature() { } + /** + * The transaction signature date. Format: yyyy-MM-dd + * + * @param sepadirectdebitDateOfSignature + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_DATE_OF_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitDateOfSignature(String sepadirectdebitDateOfSignature) { @@ -92,6 +97,11 @@ public String getSepadirectdebitMandateId() { } + /** + * Its value corresponds to the pspReference value of the transaction. + * + * @param sepadirectdebitMandateId + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_MANDATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitMandateId(String sepadirectdebitMandateId) { @@ -117,6 +127,11 @@ public String getSepadirectdebitSequenceType() { } + /** + * This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF + * + * @param sepadirectdebitSequenceType + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_SEQUENCE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitSequenceType(String sepadirectdebitSequenceType) { diff --git a/src/main/java/com/adyen/model/checkout/ResponsePaymentMethod.java b/src/main/java/com/adyen/model/checkout/ResponsePaymentMethod.java index 8a9154047..077d46897 100644 --- a/src/main/java/com/adyen/model/checkout/ResponsePaymentMethod.java +++ b/src/main/java/com/adyen/model/checkout/ResponsePaymentMethod.java @@ -63,6 +63,11 @@ public String getBrand() { } + /** + * The card brand that the shopper used to pay. Only returned if `paymentMethod.type` is **scheme**. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * The `paymentMethod.type` value used in the request. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/RiskData.java b/src/main/java/com/adyen/model/checkout/RiskData.java index cbe2f3149..cccffdd37 100644 --- a/src/main/java/com/adyen/model/checkout/RiskData.java +++ b/src/main/java/com/adyen/model/checkout/RiskData.java @@ -74,6 +74,11 @@ public String getClientData() { } + /** + * Contains client-side data, like the device fingerprint, cookies, and specific browser settings. + * + * @param clientData + */ @JsonProperty(JSON_PROPERTY_CLIENT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientData(String clientData) { @@ -107,6 +112,11 @@ public Map getCustomFields() { } + /** + * Any custom fields used as part of the input to configured risk rules. + * + * @param customFields + */ @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomFields(Map customFields) { @@ -132,6 +142,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -157,6 +172,11 @@ public String getProfileReference() { } + /** + * The risk profile to assign to this payment. When left empty, the merchant-level account's default risk profile will be applied. + * + * @param profileReference + */ @JsonProperty(JSON_PROPERTY_PROFILE_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProfileReference(String profileReference) { diff --git a/src/main/java/com/adyen/model/checkout/SDKEphemPubKey.java b/src/main/java/com/adyen/model/checkout/SDKEphemPubKey.java index 14435cc18..3cb050343 100644 --- a/src/main/java/com/adyen/model/checkout/SDKEphemPubKey.java +++ b/src/main/java/com/adyen/model/checkout/SDKEphemPubKey.java @@ -71,6 +71,11 @@ public String getCrv() { } + /** + * The `crv` value as received from the 3D Secure 2 SDK. + * + * @param crv + */ @JsonProperty(JSON_PROPERTY_CRV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCrv(String crv) { @@ -96,6 +101,11 @@ public String getKty() { } + /** + * The `kty` value as received from the 3D Secure 2 SDK. + * + * @param kty + */ @JsonProperty(JSON_PROPERTY_KTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setKty(String kty) { @@ -121,6 +131,11 @@ public String getX() { } + /** + * The `x` value as received from the 3D Secure 2 SDK. + * + * @param x + */ @JsonProperty(JSON_PROPERTY_X) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(String x) { @@ -146,6 +161,11 @@ public String getY() { } + /** + * The `y` value as received from the 3D Secure 2 SDK. + * + * @param y + */ @JsonProperty(JSON_PROPERTY_Y) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(String y) { diff --git a/src/main/java/com/adyen/model/checkout/SamsungPayDetails.java b/src/main/java/com/adyen/model/checkout/SamsungPayDetails.java index bb4fd4087..67ded37a6 100644 --- a/src/main/java/com/adyen/model/checkout/SamsungPayDetails.java +++ b/src/main/java/com/adyen/model/checkout/SamsungPayDetails.java @@ -147,6 +147,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -172,6 +177,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -199,6 +209,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -225,6 +240,11 @@ public String getSamsungPayToken() { } + /** + * The payload you received from the Samsung Pay SDK response. + * + * @param samsungPayToken + */ @JsonProperty(JSON_PROPERTY_SAMSUNG_PAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSamsungPayToken(String samsungPayToken) { @@ -250,6 +270,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -275,6 +300,11 @@ public TypeEnum getType() { } + /** + * **samsungpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/SepaDirectDebitDetails.java b/src/main/java/com/adyen/model/checkout/SepaDirectDebitDetails.java index 981639281..ed65e67eb 100644 --- a/src/main/java/com/adyen/model/checkout/SepaDirectDebitDetails.java +++ b/src/main/java/com/adyen/model/checkout/SepaDirectDebitDetails.java @@ -114,6 +114,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -139,6 +144,11 @@ public String getIban() { } + /** + * The International Bank Account Number (IBAN). + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -164,6 +174,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -191,6 +206,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -217,6 +237,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -242,6 +267,11 @@ public TypeEnum getType() { } + /** + * **sepadirectdebit** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/ServiceError.java b/src/main/java/com/adyen/model/checkout/ServiceError.java index 25edc923d..ce4e931ce 100644 --- a/src/main/java/com/adyen/model/checkout/ServiceError.java +++ b/src/main/java/com/adyen/model/checkout/ServiceError.java @@ -90,6 +90,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -115,6 +120,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -140,6 +150,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -165,6 +180,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -190,6 +210,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -215,6 +240,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/checkout/ServiceErrorDetails.java b/src/main/java/com/adyen/model/checkout/ServiceErrorDetails.java index a7c7916e4..f11bc544f 100644 --- a/src/main/java/com/adyen/model/checkout/ServiceErrorDetails.java +++ b/src/main/java/com/adyen/model/checkout/ServiceErrorDetails.java @@ -71,6 +71,11 @@ public String getErrorCode() { } + /** + * errorCode + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -96,6 +101,11 @@ public String getErrorType() { } + /** + * errorType + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -121,6 +131,11 @@ public String getMessage() { } + /** + * message + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -146,6 +161,11 @@ public String getPspReference() { } + /** + * pspReference + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { diff --git a/src/main/java/com/adyen/model/checkout/SessionResultResponse.java b/src/main/java/com/adyen/model/checkout/SessionResultResponse.java index e3ca8c1a9..a08283b23 100644 --- a/src/main/java/com/adyen/model/checkout/SessionResultResponse.java +++ b/src/main/java/com/adyen/model/checkout/SessionResultResponse.java @@ -106,6 +106,11 @@ public String getId() { } + /** + * A unique identifier of the session. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -131,6 +136,11 @@ public StatusEnum getStatus() { } + /** + * The status of the session. The status included in the response doesn't get updated. Don't make the request again to check for payment status updates. Possible values: * **completed** – The shopper completed the payment. This means that the payment was authorized. * **paymentPending** – The shopper is in the process of making the payment. This applies to payment methods with an asynchronous flow. * **refused** – The session has been refused, due to too many refused payment attempts. Shoppers can no longer complete the payment with this session. * **canceled** – The shopper canceled the payment. * **active** – The session is still active and can be paid. * **expired** – The session expired (default: 1 hour after session creation). Shoppers can no longer complete the payment with this session. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/ShopperInput.java b/src/main/java/com/adyen/model/checkout/ShopperInput.java index c617e833b..4c5499017 100644 --- a/src/main/java/com/adyen/model/checkout/ShopperInput.java +++ b/src/main/java/com/adyen/model/checkout/ShopperInput.java @@ -178,6 +178,11 @@ public BillingAddressEnum getBillingAddress() { } + /** + * Specifies visibility of billing address fields. Permitted values: * editable * hidden * readOnly + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(BillingAddressEnum billingAddress) { @@ -203,6 +208,11 @@ public DeliveryAddressEnum getDeliveryAddress() { } + /** + * Specifies visibility of delivery address fields. Permitted values: * editable * hidden * readOnly + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(DeliveryAddressEnum deliveryAddress) { @@ -228,6 +238,11 @@ public PersonalDetailsEnum getPersonalDetails() { } + /** + * Specifies visibility of personal details. Permitted values: * editable * hidden * readOnly + * + * @param personalDetails + */ @JsonProperty(JSON_PROPERTY_PERSONAL_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPersonalDetails(PersonalDetailsEnum personalDetails) { diff --git a/src/main/java/com/adyen/model/checkout/ShopperInteractionDevice.java b/src/main/java/com/adyen/model/checkout/ShopperInteractionDevice.java index 7c65af0a1..bac6cbba9 100644 --- a/src/main/java/com/adyen/model/checkout/ShopperInteractionDevice.java +++ b/src/main/java/com/adyen/model/checkout/ShopperInteractionDevice.java @@ -67,6 +67,11 @@ public String getLocale() { } + /** + * Locale on the shopper interaction device. + * + * @param locale + */ @JsonProperty(JSON_PROPERTY_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocale(String locale) { @@ -92,6 +97,11 @@ public String getOs() { } + /** + * Operating system running on the shopper interaction device. + * + * @param os + */ @JsonProperty(JSON_PROPERTY_OS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOs(String os) { @@ -117,6 +127,11 @@ public String getOsVersion() { } + /** + * Version of the operating system on the shopper interaction device. + * + * @param osVersion + */ @JsonProperty(JSON_PROPERTY_OS_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOsVersion(String osVersion) { diff --git a/src/main/java/com/adyen/model/checkout/Split.java b/src/main/java/com/adyen/model/checkout/Split.java index a9a5dd2fd..c7a959804 100644 --- a/src/main/java/com/adyen/model/checkout/Split.java +++ b/src/main/java/com/adyen/model/checkout/Split.java @@ -125,6 +125,11 @@ public String getAccount() { } + /** + * The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked. + * + * @param account + */ @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(String account) { @@ -150,6 +155,11 @@ public SplitAmount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(SplitAmount amount) { @@ -175,6 +185,11 @@ public String getDescription() { } + /** + * Your description for the split item. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -200,6 +215,11 @@ public String getReference() { } + /** + * Your unique reference for the split item. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -225,6 +245,11 @@ public TypeEnum getType() { } + /** + * The type of the split item. Possible values: * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/SplitAmount.java b/src/main/java/com/adyen/model/checkout/SplitAmount.java index 8bf28f610..78cfa5bb2 100644 --- a/src/main/java/com/adyen/model/checkout/SplitAmount.java +++ b/src/main/java/com/adyen/model/checkout/SplitAmount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelRequest.java b/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelRequest.java index 3b227eec2..dce080921 100644 --- a/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelRequest.java +++ b/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelRequest.java @@ -72,6 +72,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -97,6 +102,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -122,6 +132,11 @@ public String getPaymentReference() { } + /** + * The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment that you want to cancel. + * + * @param paymentReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentReference(String paymentReference) { @@ -147,6 +162,11 @@ public String getReference() { } + /** + * Your reference for the cancel request. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelResponse.java b/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelResponse.java index ee99f769f..00b39af0a 100644 --- a/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelResponse.java +++ b/src/main/java/com/adyen/model/checkout/StandalonePaymentCancelResponse.java @@ -108,6 +108,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -133,6 +138,11 @@ public String getPaymentReference() { } + /** + * The [`reference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__reqParam_reference) of the payment to cancel. + * + * @param paymentReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentReference(String paymentReference) { @@ -158,6 +168,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the cancel request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -183,6 +198,11 @@ public String getReference() { } + /** + * Your reference for the cancel request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -208,6 +228,11 @@ public StatusEnum getStatus() { } + /** + * The status of your request. This will always have the value **received**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/StoredDetails.java b/src/main/java/com/adyen/model/checkout/StoredDetails.java index 4cf4cc7e7..61e0e03d5 100644 --- a/src/main/java/com/adyen/model/checkout/StoredDetails.java +++ b/src/main/java/com/adyen/model/checkout/StoredDetails.java @@ -69,6 +69,11 @@ public BankAccount getBank() { } + /** + * bank + * + * @param bank + */ @JsonProperty(JSON_PROPERTY_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBank(BankAccount bank) { @@ -94,6 +99,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -119,6 +129,11 @@ public String getEmailAddress() { } + /** + * The email associated with stored payment details. + * + * @param emailAddress + */ @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmailAddress(String emailAddress) { diff --git a/src/main/java/com/adyen/model/checkout/StoredPaymentMethod.java b/src/main/java/com/adyen/model/checkout/StoredPaymentMethod.java index 48d1a77ea..bd850075c 100644 --- a/src/main/java/com/adyen/model/checkout/StoredPaymentMethod.java +++ b/src/main/java/com/adyen/model/checkout/StoredPaymentMethod.java @@ -125,6 +125,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -150,6 +155,11 @@ public String getBankLocationId() { } + /** + * The location id of the bank. The field value is `nil` in most cases. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -175,6 +185,11 @@ public String getBrand() { } + /** + * The brand of the card. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -200,6 +215,11 @@ public String getExpiryMonth() { } + /** + * The month the card expires. + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -225,6 +245,11 @@ public String getExpiryYear() { } + /** + * The last two digits of the year the card expires. For example, **22** for the year 2022. + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -250,6 +275,11 @@ public String getHolderName() { } + /** + * The unique payment method code. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -275,6 +305,11 @@ public String getIban() { } + /** + * The IBAN of the bank account. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -300,6 +335,11 @@ public String getId() { } + /** + * A unique identifier of this stored payment method. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -325,6 +365,11 @@ public String getLabel() { } + /** + * The shopper’s issuer account label + * + * @param label + */ @JsonProperty(JSON_PROPERTY_LABEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLabel(String label) { @@ -350,6 +395,11 @@ public String getLastFour() { } + /** + * The last four digits of the PAN. + * + * @param lastFour + */ @JsonProperty(JSON_PROPERTY_LAST_FOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastFour(String lastFour) { @@ -375,6 +425,11 @@ public String getName() { } + /** + * The display name of the stored payment method. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -400,6 +455,11 @@ public String getNetworkTxReference() { } + /** + * Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -425,6 +485,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -450,6 +515,11 @@ public String getShopperEmail() { } + /** + * The shopper’s email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -483,6 +553,11 @@ public List getSupportedRecurringProcessingModels() { } + /** + * The supported recurring processing models for this stored payment method. + * + * @param supportedRecurringProcessingModels + */ @JsonProperty(JSON_PROPERTY_SUPPORTED_RECURRING_PROCESSING_MODELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportedRecurringProcessingModels(List supportedRecurringProcessingModels) { @@ -516,6 +591,11 @@ public List getSupportedShopperInteractions() { } + /** + * The supported shopper interactions for this stored payment method. + * + * @param supportedShopperInteractions + */ @JsonProperty(JSON_PROPERTY_SUPPORTED_SHOPPER_INTERACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportedShopperInteractions(List supportedShopperInteractions) { @@ -541,6 +621,11 @@ public String getType() { } + /** + * The type of payment method. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/StoredPaymentMethodDetails.java b/src/main/java/com/adyen/model/checkout/StoredPaymentMethodDetails.java index 4791c5a7f..a2cc561f2 100644 --- a/src/main/java/com/adyen/model/checkout/StoredPaymentMethodDetails.java +++ b/src/main/java/com/adyen/model/checkout/StoredPaymentMethodDetails.java @@ -138,6 +138,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -165,6 +170,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -191,6 +201,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -216,6 +231,11 @@ public TypeEnum getType() { } + /** + * The payment method type. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/StoredPaymentMethodResource.java b/src/main/java/com/adyen/model/checkout/StoredPaymentMethodResource.java index 35d052a0b..28f5c9a34 100644 --- a/src/main/java/com/adyen/model/checkout/StoredPaymentMethodResource.java +++ b/src/main/java/com/adyen/model/checkout/StoredPaymentMethodResource.java @@ -125,6 +125,11 @@ public String getBrand() { } + /** + * The brand of the card. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -150,6 +155,11 @@ public String getExpiryMonth() { } + /** + * The month the card expires. + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -175,6 +185,11 @@ public String getExpiryYear() { } + /** + * The last two digits of the year the card expires. For example, **22** for the year 2022. + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -200,6 +215,11 @@ public String getExternalResponseCode() { } + /** + * The response code returned by an external system (for example after a provisioning operation). + * + * @param externalResponseCode + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_RESPONSE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalResponseCode(String externalResponseCode) { @@ -225,6 +245,11 @@ public String getExternalTokenReference() { } + /** + * The token reference of a linked token in an external system (for example a network token reference). + * + * @param externalTokenReference + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_TOKEN_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalTokenReference(String externalTokenReference) { @@ -250,6 +275,11 @@ public String getHolderName() { } + /** + * The unique payment method code. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -275,6 +305,11 @@ public String getIban() { } + /** + * The IBAN of the bank account. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -300,6 +335,11 @@ public String getId() { } + /** + * A unique identifier of this stored payment method. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -325,6 +365,11 @@ public String getIssuerName() { } + /** + * The name of the issuer of token or card. + * + * @param issuerName + */ @JsonProperty(JSON_PROPERTY_ISSUER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerName(String issuerName) { @@ -350,6 +395,11 @@ public String getLastFour() { } + /** + * The last four digits of the PAN. + * + * @param lastFour + */ @JsonProperty(JSON_PROPERTY_LAST_FOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastFour(String lastFour) { @@ -375,6 +425,11 @@ public String getName() { } + /** + * The display name of the stored payment method. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -400,6 +455,11 @@ public String getNetworkTxReference() { } + /** + * Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -425,6 +485,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -450,6 +515,11 @@ public String getShopperEmail() { } + /** + * The shopper’s email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -475,6 +545,11 @@ public String getShopperReference() { } + /** + * Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -508,6 +583,11 @@ public List getSupportedRecurringProcessingModels() { } + /** + * Defines a recurring payment type. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param supportedRecurringProcessingModels + */ @JsonProperty(JSON_PROPERTY_SUPPORTED_RECURRING_PROCESSING_MODELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportedRecurringProcessingModels(List supportedRecurringProcessingModels) { @@ -533,6 +613,11 @@ public String getType() { } + /** + * The type of payment method. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/checkout/SubInputDetail.java b/src/main/java/com/adyen/model/checkout/SubInputDetail.java index 0d71e5b70..23eb867cb 100644 --- a/src/main/java/com/adyen/model/checkout/SubInputDetail.java +++ b/src/main/java/com/adyen/model/checkout/SubInputDetail.java @@ -92,6 +92,11 @@ public Map getConfiguration() { } + /** + * Configuration parameters for the required input. + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(Map configuration) { @@ -125,6 +130,11 @@ public List getItems() { } + /** + * In case of a select, the items to choose from. + * + * @param items + */ @JsonProperty(JSON_PROPERTY_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItems(List items) { @@ -150,6 +160,11 @@ public String getKey() { } + /** + * The value to provide in the result. + * + * @param key + */ @JsonProperty(JSON_PROPERTY_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setKey(String key) { @@ -175,6 +190,11 @@ public Boolean getOptional() { } + /** + * True if this input is optional to provide. + * + * @param optional + */ @JsonProperty(JSON_PROPERTY_OPTIONAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOptional(Boolean optional) { @@ -200,6 +220,11 @@ public String getType() { } + /** + * The type of the required input. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -225,6 +250,11 @@ public String getValue() { } + /** + * The value can be pre-filled, if available. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(String value) { diff --git a/src/main/java/com/adyen/model/checkout/SubMerchant.java b/src/main/java/com/adyen/model/checkout/SubMerchant.java index e8b8c2e19..9a5b38449 100644 --- a/src/main/java/com/adyen/model/checkout/SubMerchant.java +++ b/src/main/java/com/adyen/model/checkout/SubMerchant.java @@ -75,6 +75,11 @@ public String getCity() { } + /** + * The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -100,6 +105,11 @@ public String getCountry() { } + /** + * The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -125,6 +135,11 @@ public String getMcc() { } + /** + * The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -150,6 +165,11 @@ public String getName() { } + /** + * The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -175,6 +195,11 @@ public String getTaxId() { } + /** + * The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/checkout/SubMerchantInfo.java b/src/main/java/com/adyen/model/checkout/SubMerchantInfo.java index f25b474b4..12296de8a 100644 --- a/src/main/java/com/adyen/model/checkout/SubMerchantInfo.java +++ b/src/main/java/com/adyen/model/checkout/SubMerchantInfo.java @@ -76,6 +76,11 @@ public BillingAddress getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(BillingAddress address) { @@ -101,6 +106,11 @@ public String getId() { } + /** + * id + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -126,6 +136,11 @@ public String getMcc() { } + /** + * mcc + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -151,6 +166,11 @@ public String getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -176,6 +196,11 @@ public String getTaxId() { } + /** + * taxId + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDS2RequestData.java b/src/main/java/com/adyen/model/checkout/ThreeDS2RequestData.java index 14b520386..778f82da8 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDS2RequestData.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDS2RequestData.java @@ -453,6 +453,11 @@ public AcctInfo getAcctInfo() { } + /** + * acctInfo + * + * @param acctInfo + */ @JsonProperty(JSON_PROPERTY_ACCT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctInfo(AcctInfo acctInfo) { @@ -478,6 +483,11 @@ public AcctTypeEnum getAcctType() { } + /** + * Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit + * + * @param acctType + */ @JsonProperty(JSON_PROPERTY_ACCT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctType(AcctTypeEnum acctType) { @@ -503,6 +513,11 @@ public String getAcquirerBIN() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. + * + * @param acquirerBIN + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_B_I_N) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerBIN(String acquirerBIN) { @@ -528,6 +543,11 @@ public String getAcquirerMerchantID() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. + * + * @param acquirerMerchantID + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_MERCHANT_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerMerchantID(String acquirerMerchantID) { @@ -553,6 +573,11 @@ public AddrMatchEnum getAddrMatch() { } + /** + * Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address. + * + * @param addrMatch + */ @JsonProperty(JSON_PROPERTY_ADDR_MATCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddrMatch(AddrMatchEnum addrMatch) { @@ -580,6 +605,11 @@ public Boolean getAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param authenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -608,6 +638,11 @@ public ChallengeIndicatorEnum getChallengeIndicator() { } + /** + * Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` + * + * @param challengeIndicator + */ @Deprecated @JsonProperty(JSON_PROPERTY_CHALLENGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -634,6 +669,11 @@ public String getDeviceChannel() { } + /** + * The environment of the shopper. Allowed values: * `app` * `browser` + * + * @param deviceChannel + */ @JsonProperty(JSON_PROPERTY_DEVICE_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceChannel(String deviceChannel) { @@ -659,6 +699,11 @@ public DeviceRenderOptions getDeviceRenderOptions() { } + /** + * deviceRenderOptions + * + * @param deviceRenderOptions + */ @JsonProperty(JSON_PROPERTY_DEVICE_RENDER_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceRenderOptions(DeviceRenderOptions deviceRenderOptions) { @@ -684,6 +729,11 @@ public Phone getHomePhone() { } + /** + * homePhone + * + * @param homePhone + */ @JsonProperty(JSON_PROPERTY_HOME_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHomePhone(Phone homePhone) { @@ -709,6 +759,11 @@ public String getMcc() { } + /** + * Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -734,6 +789,11 @@ public String getMerchantName() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters. > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account. + * + * @param merchantName + */ @JsonProperty(JSON_PROPERTY_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantName(String merchantName) { @@ -759,6 +819,11 @@ public String getMessageVersion() { } + /** + * The `messageVersion` value indicating the 3D Secure 2 protocol version. + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -784,6 +849,11 @@ public Phone getMobilePhone() { } + /** + * mobilePhone + * + * @param mobilePhone + */ @JsonProperty(JSON_PROPERTY_MOBILE_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMobilePhone(Phone mobilePhone) { @@ -809,6 +879,11 @@ public String getNotificationURL() { } + /** + * URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. + * + * @param notificationURL + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationURL(String notificationURL) { @@ -834,6 +909,11 @@ public Boolean getPayTokenInd() { } + /** + * Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. + * + * @param payTokenInd + */ @JsonProperty(JSON_PROPERTY_PAY_TOKEN_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayTokenInd(Boolean payTokenInd) { @@ -859,6 +939,11 @@ public String getPaymentAuthenticationUseCase() { } + /** + * Indicates the type of payment for which an authentication is requested (message extension) + * + * @param paymentAuthenticationUseCase + */ @JsonProperty(JSON_PROPERTY_PAYMENT_AUTHENTICATION_USE_CASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAuthenticationUseCase(String paymentAuthenticationUseCase) { @@ -884,6 +969,11 @@ public String getPurchaseInstalData() { } + /** + * Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters. + * + * @param purchaseInstalData + */ @JsonProperty(JSON_PROPERTY_PURCHASE_INSTAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPurchaseInstalData(String purchaseInstalData) { @@ -909,6 +999,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Format: YYYYMMDD + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -934,6 +1029,11 @@ public String getRecurringFrequency() { } + /** + * Indicates the minimum number of days between authorisations. Maximum length: 4 characters. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -959,6 +1059,11 @@ public String getSdkAppID() { } + /** + * The `sdkAppID` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. + * + * @param sdkAppID + */ @JsonProperty(JSON_PROPERTY_SDK_APP_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkAppID(String sdkAppID) { @@ -984,6 +1089,11 @@ public String getSdkEncData() { } + /** + * The `sdkEncData` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. + * + * @param sdkEncData + */ @JsonProperty(JSON_PROPERTY_SDK_ENC_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkEncData(String sdkEncData) { @@ -1009,6 +1119,11 @@ public SDKEphemPubKey getSdkEphemPubKey() { } + /** + * sdkEphemPubKey + * + * @param sdkEphemPubKey + */ @JsonProperty(JSON_PROPERTY_SDK_EPHEM_PUB_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkEphemPubKey(SDKEphemPubKey sdkEphemPubKey) { @@ -1034,6 +1149,11 @@ public Integer getSdkMaxTimeout() { } + /** + * The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes. + * + * @param sdkMaxTimeout + */ @JsonProperty(JSON_PROPERTY_SDK_MAX_TIMEOUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkMaxTimeout(Integer sdkMaxTimeout) { @@ -1059,6 +1179,11 @@ public String getSdkReferenceNumber() { } + /** + * The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. + * + * @param sdkReferenceNumber + */ @JsonProperty(JSON_PROPERTY_SDK_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkReferenceNumber(String sdkReferenceNumber) { @@ -1084,6 +1209,11 @@ public String getSdkTransID() { } + /** + * The `sdkTransID` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. + * + * @param sdkTransID + */ @JsonProperty(JSON_PROPERTY_SDK_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkTransID(String sdkTransID) { @@ -1109,6 +1239,11 @@ public String getSdkVersion() { } + /** + * Version of the 3D Secure 2 mobile SDK. Only for `deviceChannel` set to **app**. + * + * @param sdkVersion + */ @JsonProperty(JSON_PROPERTY_SDK_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkVersion(String sdkVersion) { @@ -1134,6 +1269,11 @@ public String getThreeDSCompInd() { } + /** + * Completion indicator for the device fingerprinting. + * + * @param threeDSCompInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_COMP_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSCompInd(String threeDSCompInd) { @@ -1159,6 +1299,11 @@ public String getThreeDSRequestorAuthenticationInd() { } + /** + * Indicates the type of Authentication request. + * + * @param threeDSRequestorAuthenticationInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_AUTHENTICATION_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorAuthenticationInd(String threeDSRequestorAuthenticationInd) { @@ -1184,6 +1329,11 @@ public ThreeDSRequestorAuthenticationInfo getThreeDSRequestorAuthenticationInfo( } + /** + * threeDSRequestorAuthenticationInfo + * + * @param threeDSRequestorAuthenticationInfo + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_AUTHENTICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorAuthenticationInfo(ThreeDSRequestorAuthenticationInfo threeDSRequestorAuthenticationInfo) { @@ -1209,6 +1359,11 @@ public ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd() { } + /** + * Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only + * + * @param threeDSRequestorChallengeInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorChallengeInd(ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd) { @@ -1234,6 +1389,11 @@ public String getThreeDSRequestorID() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2. + * + * @param threeDSRequestorID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorID(String threeDSRequestorID) { @@ -1259,6 +1419,11 @@ public String getThreeDSRequestorName() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2. + * + * @param threeDSRequestorName + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorName(String threeDSRequestorName) { @@ -1284,6 +1449,11 @@ public ThreeDSRequestorPriorAuthenticationInfo getThreeDSRequestorPriorAuthentic } + /** + * threeDSRequestorPriorAuthenticationInfo + * + * @param threeDSRequestorPriorAuthenticationInfo + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_PRIOR_AUTHENTICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorPriorAuthenticationInfo(ThreeDSRequestorPriorAuthenticationInfo threeDSRequestorPriorAuthenticationInfo) { @@ -1309,6 +1479,11 @@ public String getThreeDSRequestorURL() { } + /** + * URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process. + * + * @param threeDSRequestorURL + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorURL(String threeDSRequestorURL) { @@ -1334,6 +1509,11 @@ public TransTypeEnum getTransType() { } + /** + * Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi-Cash Transaction * **28** — Prepaid Activation and Load + * + * @param transType + */ @JsonProperty(JSON_PROPERTY_TRANS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransType(TransTypeEnum transType) { @@ -1359,6 +1539,11 @@ public TransactionTypeEnum getTransactionType() { } + /** + * Identify the type of the transaction being authenticated. + * + * @param transactionType + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionType(TransactionTypeEnum transactionType) { @@ -1384,6 +1569,11 @@ public String getWhiteListStatus() { } + /** + * The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + * + * @param whiteListStatus + */ @JsonProperty(JSON_PROPERTY_WHITE_LIST_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWhiteListStatus(String whiteListStatus) { @@ -1409,6 +1599,11 @@ public Phone getWorkPhone() { } + /** + * workPhone + * + * @param workPhone + */ @JsonProperty(JSON_PROPERTY_WORK_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWorkPhone(Phone workPhone) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDS2RequestFields.java b/src/main/java/com/adyen/model/checkout/ThreeDS2RequestFields.java index 5dcd73165..529d61a38 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDS2RequestFields.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDS2RequestFields.java @@ -441,6 +441,11 @@ public AcctInfo getAcctInfo() { } + /** + * acctInfo + * + * @param acctInfo + */ @JsonProperty(JSON_PROPERTY_ACCT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctInfo(AcctInfo acctInfo) { @@ -466,6 +471,11 @@ public AcctTypeEnum getAcctType() { } + /** + * Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit + * + * @param acctType + */ @JsonProperty(JSON_PROPERTY_ACCT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctType(AcctTypeEnum acctType) { @@ -491,6 +501,11 @@ public String getAcquirerBIN() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. + * + * @param acquirerBIN + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_B_I_N) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerBIN(String acquirerBIN) { @@ -516,6 +531,11 @@ public String getAcquirerMerchantID() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. + * + * @param acquirerMerchantID + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_MERCHANT_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerMerchantID(String acquirerMerchantID) { @@ -541,6 +561,11 @@ public AddrMatchEnum getAddrMatch() { } + /** + * Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address. + * + * @param addrMatch + */ @JsonProperty(JSON_PROPERTY_ADDR_MATCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddrMatch(AddrMatchEnum addrMatch) { @@ -568,6 +593,11 @@ public Boolean getAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param authenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -596,6 +626,11 @@ public ChallengeIndicatorEnum getChallengeIndicator() { } + /** + * Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` + * + * @param challengeIndicator + */ @Deprecated @JsonProperty(JSON_PROPERTY_CHALLENGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -622,6 +657,11 @@ public DeviceRenderOptions getDeviceRenderOptions() { } + /** + * deviceRenderOptions + * + * @param deviceRenderOptions + */ @JsonProperty(JSON_PROPERTY_DEVICE_RENDER_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceRenderOptions(DeviceRenderOptions deviceRenderOptions) { @@ -647,6 +687,11 @@ public Phone getHomePhone() { } + /** + * homePhone + * + * @param homePhone + */ @JsonProperty(JSON_PROPERTY_HOME_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHomePhone(Phone homePhone) { @@ -672,6 +717,11 @@ public String getMcc() { } + /** + * Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -697,6 +747,11 @@ public String getMerchantName() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters. > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account. + * + * @param merchantName + */ @JsonProperty(JSON_PROPERTY_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantName(String merchantName) { @@ -722,6 +777,11 @@ public String getMessageVersion() { } + /** + * The `messageVersion` value indicating the 3D Secure 2 protocol version. + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -747,6 +807,11 @@ public Phone getMobilePhone() { } + /** + * mobilePhone + * + * @param mobilePhone + */ @JsonProperty(JSON_PROPERTY_MOBILE_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMobilePhone(Phone mobilePhone) { @@ -772,6 +837,11 @@ public String getNotificationURL() { } + /** + * URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. + * + * @param notificationURL + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationURL(String notificationURL) { @@ -797,6 +867,11 @@ public Boolean getPayTokenInd() { } + /** + * Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. + * + * @param payTokenInd + */ @JsonProperty(JSON_PROPERTY_PAY_TOKEN_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayTokenInd(Boolean payTokenInd) { @@ -822,6 +897,11 @@ public String getPaymentAuthenticationUseCase() { } + /** + * Indicates the type of payment for which an authentication is requested (message extension) + * + * @param paymentAuthenticationUseCase + */ @JsonProperty(JSON_PROPERTY_PAYMENT_AUTHENTICATION_USE_CASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAuthenticationUseCase(String paymentAuthenticationUseCase) { @@ -847,6 +927,11 @@ public String getPurchaseInstalData() { } + /** + * Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters. + * + * @param purchaseInstalData + */ @JsonProperty(JSON_PROPERTY_PURCHASE_INSTAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPurchaseInstalData(String purchaseInstalData) { @@ -872,6 +957,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Format: YYYYMMDD + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -897,6 +987,11 @@ public String getRecurringFrequency() { } + /** + * Indicates the minimum number of days between authorisations. Maximum length: 4 characters. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -922,6 +1017,11 @@ public String getSdkAppID() { } + /** + * The `sdkAppID` value as received from the 3D Secure 2 SDK. + * + * @param sdkAppID + */ @JsonProperty(JSON_PROPERTY_SDK_APP_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkAppID(String sdkAppID) { @@ -947,6 +1047,11 @@ public SDKEphemPubKey getSdkEphemPubKey() { } + /** + * sdkEphemPubKey + * + * @param sdkEphemPubKey + */ @JsonProperty(JSON_PROPERTY_SDK_EPHEM_PUB_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkEphemPubKey(SDKEphemPubKey sdkEphemPubKey) { @@ -972,6 +1077,11 @@ public Integer getSdkMaxTimeout() { } + /** + * The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes. + * + * @param sdkMaxTimeout + */ @JsonProperty(JSON_PROPERTY_SDK_MAX_TIMEOUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkMaxTimeout(Integer sdkMaxTimeout) { @@ -997,6 +1107,11 @@ public String getSdkReferenceNumber() { } + /** + * The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. + * + * @param sdkReferenceNumber + */ @JsonProperty(JSON_PROPERTY_SDK_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkReferenceNumber(String sdkReferenceNumber) { @@ -1022,6 +1137,11 @@ public String getSdkTransID() { } + /** + * The `sdkTransID` value as received from the 3D Secure 2 SDK. + * + * @param sdkTransID + */ @JsonProperty(JSON_PROPERTY_SDK_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkTransID(String sdkTransID) { @@ -1047,6 +1167,11 @@ public String getThreeDSCompInd() { } + /** + * Completion indicator for the device fingerprinting. + * + * @param threeDSCompInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_COMP_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSCompInd(String threeDSCompInd) { @@ -1072,6 +1197,11 @@ public String getThreeDSRequestorAuthenticationInd() { } + /** + * Indicates the type of Authentication request. + * + * @param threeDSRequestorAuthenticationInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_AUTHENTICATION_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorAuthenticationInd(String threeDSRequestorAuthenticationInd) { @@ -1097,6 +1227,11 @@ public ThreeDSRequestorAuthenticationInfo getThreeDSRequestorAuthenticationInfo( } + /** + * threeDSRequestorAuthenticationInfo + * + * @param threeDSRequestorAuthenticationInfo + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_AUTHENTICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorAuthenticationInfo(ThreeDSRequestorAuthenticationInfo threeDSRequestorAuthenticationInfo) { @@ -1122,6 +1257,11 @@ public ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd() { } + /** + * Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only + * + * @param threeDSRequestorChallengeInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorChallengeInd(ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd) { @@ -1147,6 +1287,11 @@ public String getThreeDSRequestorID() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2. + * + * @param threeDSRequestorID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorID(String threeDSRequestorID) { @@ -1172,6 +1317,11 @@ public String getThreeDSRequestorName() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2. + * + * @param threeDSRequestorName + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorName(String threeDSRequestorName) { @@ -1197,6 +1347,11 @@ public ThreeDSRequestorPriorAuthenticationInfo getThreeDSRequestorPriorAuthentic } + /** + * threeDSRequestorPriorAuthenticationInfo + * + * @param threeDSRequestorPriorAuthenticationInfo + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_PRIOR_AUTHENTICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorPriorAuthenticationInfo(ThreeDSRequestorPriorAuthenticationInfo threeDSRequestorPriorAuthenticationInfo) { @@ -1222,6 +1377,11 @@ public String getThreeDSRequestorURL() { } + /** + * URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process. + * + * @param threeDSRequestorURL + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorURL(String threeDSRequestorURL) { @@ -1247,6 +1407,11 @@ public TransTypeEnum getTransType() { } + /** + * Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi-Cash Transaction * **28** — Prepaid Activation and Load + * + * @param transType + */ @JsonProperty(JSON_PROPERTY_TRANS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransType(TransTypeEnum transType) { @@ -1272,6 +1437,11 @@ public TransactionTypeEnum getTransactionType() { } + /** + * Identify the type of the transaction being authenticated. + * + * @param transactionType + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionType(TransactionTypeEnum transactionType) { @@ -1297,6 +1467,11 @@ public String getWhiteListStatus() { } + /** + * The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + * + * @param whiteListStatus + */ @JsonProperty(JSON_PROPERTY_WHITE_LIST_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWhiteListStatus(String whiteListStatus) { @@ -1322,6 +1497,11 @@ public Phone getWorkPhone() { } + /** + * workPhone + * + * @param workPhone + */ @JsonProperty(JSON_PROPERTY_WORK_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWorkPhone(Phone workPhone) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDS2ResponseData.java b/src/main/java/com/adyen/model/checkout/ThreeDS2ResponseData.java index eba42a723..73ebf19ad 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDS2ResponseData.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDS2ResponseData.java @@ -131,6 +131,11 @@ public String getAcsChallengeMandated() { } + /** + * acsChallengeMandated + * + * @param acsChallengeMandated + */ @JsonProperty(JSON_PROPERTY_ACS_CHALLENGE_MANDATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsChallengeMandated(String acsChallengeMandated) { @@ -156,6 +161,11 @@ public String getAcsOperatorID() { } + /** + * acsOperatorID + * + * @param acsOperatorID + */ @JsonProperty(JSON_PROPERTY_ACS_OPERATOR_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsOperatorID(String acsOperatorID) { @@ -181,6 +191,11 @@ public String getAcsReferenceNumber() { } + /** + * acsReferenceNumber + * + * @param acsReferenceNumber + */ @JsonProperty(JSON_PROPERTY_ACS_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsReferenceNumber(String acsReferenceNumber) { @@ -206,6 +221,11 @@ public String getAcsSignedContent() { } + /** + * acsSignedContent + * + * @param acsSignedContent + */ @JsonProperty(JSON_PROPERTY_ACS_SIGNED_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsSignedContent(String acsSignedContent) { @@ -231,6 +251,11 @@ public String getAcsTransID() { } + /** + * acsTransID + * + * @param acsTransID + */ @JsonProperty(JSON_PROPERTY_ACS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsTransID(String acsTransID) { @@ -256,6 +281,11 @@ public String getAcsURL() { } + /** + * acsURL + * + * @param acsURL + */ @JsonProperty(JSON_PROPERTY_ACS_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcsURL(String acsURL) { @@ -281,6 +311,11 @@ public String getAuthenticationType() { } + /** + * authenticationType + * + * @param authenticationType + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationType(String authenticationType) { @@ -306,6 +341,11 @@ public String getCardHolderInfo() { } + /** + * cardHolderInfo + * + * @param cardHolderInfo + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderInfo(String cardHolderInfo) { @@ -331,6 +371,11 @@ public String getCavvAlgorithm() { } + /** + * cavvAlgorithm + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -356,6 +401,11 @@ public String getChallengeIndicator() { } + /** + * challengeIndicator + * + * @param challengeIndicator + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeIndicator(String challengeIndicator) { @@ -381,6 +431,11 @@ public String getDsReferenceNumber() { } + /** + * dsReferenceNumber + * + * @param dsReferenceNumber + */ @JsonProperty(JSON_PROPERTY_DS_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsReferenceNumber(String dsReferenceNumber) { @@ -406,6 +461,11 @@ public String getDsTransID() { } + /** + * dsTransID + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -431,6 +491,11 @@ public String getExemptionIndicator() { } + /** + * exemptionIndicator + * + * @param exemptionIndicator + */ @JsonProperty(JSON_PROPERTY_EXEMPTION_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExemptionIndicator(String exemptionIndicator) { @@ -456,6 +521,11 @@ public String getMessageVersion() { } + /** + * messageVersion + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -481,6 +551,11 @@ public String getRiskScore() { } + /** + * riskScore + * + * @param riskScore + */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskScore(String riskScore) { @@ -506,6 +581,11 @@ public String getSdkEphemPubKey() { } + /** + * sdkEphemPubKey + * + * @param sdkEphemPubKey + */ @JsonProperty(JSON_PROPERTY_SDK_EPHEM_PUB_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkEphemPubKey(String sdkEphemPubKey) { @@ -531,6 +611,11 @@ public String getThreeDSServerTransID() { } + /** + * threeDSServerTransID + * + * @param threeDSServerTransID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSServerTransID(String threeDSServerTransID) { @@ -556,6 +641,11 @@ public String getTransStatus() { } + /** + * transStatus + * + * @param transStatus + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatus(String transStatus) { @@ -581,6 +671,11 @@ public String getTransStatusReason() { } + /** + * transStatusReason + * + * @param transStatusReason + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatusReason(String transStatusReason) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDS2Result.java b/src/main/java/com/adyen/model/checkout/ThreeDS2Result.java index 852e6670d..db967527b 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDS2Result.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDS2Result.java @@ -238,6 +238,11 @@ public String getAuthenticationValue() { } + /** + * The `authenticationValue` value as defined in the 3D Secure 2 specification. + * + * @param authenticationValue + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationValue(String authenticationValue) { @@ -263,6 +268,11 @@ public String getCavvAlgorithm() { } + /** + * The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -288,6 +298,11 @@ public ChallengeCancelEnum getChallengeCancel() { } + /** + * 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). + * + * @param challengeCancel + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_CANCEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeCancel(ChallengeCancelEnum challengeCancel) { @@ -313,6 +328,11 @@ public String getDsTransID() { } + /** + * The `dsTransID` value as defined in the 3D Secure 2 specification. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -338,6 +358,11 @@ public String getEci() { } + /** + * The `eci` value as defined in the 3D Secure 2 specification. + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -363,6 +388,11 @@ public ExemptionIndicatorEnum getExemptionIndicator() { } + /** + * Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis` + * + * @param exemptionIndicator + */ @JsonProperty(JSON_PROPERTY_EXEMPTION_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExemptionIndicator(ExemptionIndicatorEnum exemptionIndicator) { @@ -388,6 +418,11 @@ public String getMessageVersion() { } + /** + * The `messageVersion` value as defined in the 3D Secure 2 specification. + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -413,6 +448,11 @@ public String getRiskScore() { } + /** + * Risk score calculated by Cartes Bancaires Directory Server (DS). + * + * @param riskScore + */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskScore(String riskScore) { @@ -438,6 +478,11 @@ public ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd() { } + /** + * Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only + * + * @param threeDSRequestorChallengeInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorChallengeInd(ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd) { @@ -463,6 +508,11 @@ public String getThreeDSServerTransID() { } + /** + * The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. + * + * @param threeDSServerTransID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSServerTransID(String threeDSServerTransID) { @@ -488,6 +538,11 @@ public String getTimestamp() { } + /** + * The `timestamp` value of the 3D Secure 2 authentication. + * + * @param timestamp + */ @JsonProperty(JSON_PROPERTY_TIMESTAMP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimestamp(String timestamp) { @@ -513,6 +568,11 @@ public String getTransStatus() { } + /** + * The `transStatus` value as defined in the 3D Secure 2 specification. + * + * @param transStatus + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatus(String transStatus) { @@ -538,6 +598,11 @@ public String getTransStatusReason() { } + /** + * 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). + * + * @param transStatusReason + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatusReason(String transStatusReason) { @@ -563,6 +628,11 @@ public String getWhiteListStatus() { } + /** + * The `whiteListStatus` value as defined in the 3D Secure 2 specification. + * + * @param whiteListStatus + */ @JsonProperty(JSON_PROPERTY_WHITE_LIST_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWhiteListStatus(String whiteListStatus) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDSRequestData.java b/src/main/java/com/adyen/model/checkout/ThreeDSRequestData.java index af2feae3d..c6054a435 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDSRequestData.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDSRequestData.java @@ -215,6 +215,11 @@ public ChallengeWindowSizeEnum getChallengeWindowSize() { } + /** + * Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen + * + * @param challengeWindowSize + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_WINDOW_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeWindowSize(ChallengeWindowSizeEnum challengeWindowSize) { @@ -240,6 +245,11 @@ public DataOnlyEnum getDataOnly() { } + /** + * Flag for data only flow. + * + * @param dataOnly + */ @JsonProperty(JSON_PROPERTY_DATA_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDataOnly(DataOnlyEnum dataOnly) { @@ -265,6 +275,11 @@ public NativeThreeDSEnum getNativeThreeDS() { } + /** + * Indicates if [native 3D Secure authentication](https://docs.adyen.com/online-payments/3d-secure/native-3ds2) should be used when available. Possible values: * **preferred**: Use native 3D Secure authentication when available. + * + * @param nativeThreeDS + */ @JsonProperty(JSON_PROPERTY_NATIVE_THREE_D_S) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNativeThreeDS(NativeThreeDSEnum nativeThreeDS) { @@ -290,6 +305,11 @@ public ThreeDSVersionEnum getThreeDSVersion() { } + /** + * The version of 3D Secure to use. Possible values: * **2.1.0** * **2.2.0** + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(ThreeDSVersionEnum threeDSVersion) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDSRequestorAuthenticationInfo.java b/src/main/java/com/adyen/model/checkout/ThreeDSRequestorAuthenticationInfo.java index e6d53aea4..21de9d11e 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDSRequestorAuthenticationInfo.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDSRequestorAuthenticationInfo.java @@ -110,6 +110,11 @@ public String getThreeDSReqAuthData() { } + /** + * Data that documents and supports a specific authentication process. Maximum length: 2048 bytes. + * + * @param threeDSReqAuthData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_AUTH_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqAuthData(String threeDSReqAuthData) { @@ -135,6 +140,11 @@ public ThreeDSReqAuthMethodEnum getThreeDSReqAuthMethod() { } + /** + * Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values: * **01** — No 3DS Requestor authentication occurred (for example, cardholder “logged in” as guest). * **02** — Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials. * **03** — Login to the cardholder account at the 3DS Requestor system using federated ID. * **04** — Login to the cardholder account at the 3DS Requestor system using issuer credentials. * **05** — Login to the cardholder account at the 3DS Requestor system using third-party authentication. * **06** — Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator. + * + * @param threeDSReqAuthMethod + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_AUTH_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqAuthMethod(ThreeDSReqAuthMethodEnum threeDSReqAuthMethod) { @@ -160,6 +170,11 @@ public String getThreeDSReqAuthTimestamp() { } + /** + * Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM + * + * @param threeDSReqAuthTimestamp + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_AUTH_TIMESTAMP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqAuthTimestamp(String threeDSReqAuthTimestamp) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDSRequestorPriorAuthenticationInfo.java b/src/main/java/com/adyen/model/checkout/ThreeDSRequestorPriorAuthenticationInfo.java index 6e35f2749..e68f22e77 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDSRequestorPriorAuthenticationInfo.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDSRequestorPriorAuthenticationInfo.java @@ -110,6 +110,11 @@ public String getThreeDSReqPriorAuthData() { } + /** + * Data that documents and supports a specific authentication process. Maximum length: 2048 bytes. + * + * @param threeDSReqPriorAuthData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_AUTH_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorAuthData(String threeDSReqPriorAuthData) { @@ -135,6 +140,11 @@ public ThreeDSReqPriorAuthMethodEnum getThreeDSReqPriorAuthMethod() { } + /** + * Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values: * **01** — Frictionless authentication occurred by ACS. * **02** — Cardholder challenge occurred by ACS. * **03** — AVS verified. * **04** — Other issuer methods. + * + * @param threeDSReqPriorAuthMethod + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_AUTH_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorAuthMethod(ThreeDSReqPriorAuthMethodEnum threeDSReqPriorAuthMethod) { @@ -160,6 +170,11 @@ public String getThreeDSReqPriorAuthTimestamp() { } + /** + * Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM + * + * @param threeDSReqPriorAuthTimestamp + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_AUTH_TIMESTAMP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorAuthTimestamp(String threeDSReqPriorAuthTimestamp) { @@ -185,6 +200,11 @@ public String getThreeDSReqPriorRef() { } + /** + * This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters. + * + * @param threeDSReqPriorRef + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_REF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorRef(String threeDSReqPriorRef) { diff --git a/src/main/java/com/adyen/model/checkout/ThreeDSecureData.java b/src/main/java/com/adyen/model/checkout/ThreeDSecureData.java index 46af89304..9fd13963a 100644 --- a/src/main/java/com/adyen/model/checkout/ThreeDSecureData.java +++ b/src/main/java/com/adyen/model/checkout/ThreeDSecureData.java @@ -234,6 +234,11 @@ public AuthenticationResponseEnum getAuthenticationResponse() { } + /** + * In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter. + * + * @param authenticationResponse + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationResponse(AuthenticationResponseEnum authenticationResponse) { @@ -259,6 +264,11 @@ public byte[] getCavv() { } + /** + * The cardholder authentication value (base64 encoded, 20 bytes in a decoded form). + * + * @param cavv + */ @JsonProperty(JSON_PROPERTY_CAVV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavv(byte[] cavv) { @@ -284,6 +294,11 @@ public String getCavvAlgorithm() { } + /** + * The CAVV algorithm used. Include this only for 3D Secure 1. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -309,6 +324,11 @@ public ChallengeCancelEnum getChallengeCancel() { } + /** + * 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). + * + * @param challengeCancel + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_CANCEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeCancel(ChallengeCancelEnum challengeCancel) { @@ -334,6 +354,11 @@ public DirectoryResponseEnum getDirectoryResponse() { } + /** + * In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`. + * + * @param directoryResponse + */ @JsonProperty(JSON_PROPERTY_DIRECTORY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectoryResponse(DirectoryResponseEnum directoryResponse) { @@ -359,6 +384,11 @@ public String getDsTransID() { } + /** + * Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -384,6 +414,11 @@ public String getEci() { } + /** + * The electronic commerce indicator. + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -409,6 +444,11 @@ public String getRiskScore() { } + /** + * Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations. + * + * @param riskScore + */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskScore(String riskScore) { @@ -434,6 +474,11 @@ public String getThreeDSVersion() { } + /** + * The version of the 3D Secure protocol. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { @@ -459,6 +504,11 @@ public byte[] getTokenAuthenticationVerificationValue() { } + /** + * Network token authentication verification value (TAVV). The network token cryptogram. + * + * @param tokenAuthenticationVerificationValue + */ @JsonProperty(JSON_PROPERTY_TOKEN_AUTHENTICATION_VERIFICATION_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue) { @@ -484,6 +534,11 @@ public String getTransStatusReason() { } + /** + * 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). + * + * @param transStatusReason + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatusReason(String transStatusReason) { @@ -509,6 +564,11 @@ public byte[] getXid() { } + /** + * Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form). + * + * @param xid + */ @JsonProperty(JSON_PROPERTY_XID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setXid(byte[] xid) { diff --git a/src/main/java/com/adyen/model/checkout/UpdatePaymentLinkRequest.java b/src/main/java/com/adyen/model/checkout/UpdatePaymentLinkRequest.java index 8f6a8abba..57082cc4a 100644 --- a/src/main/java/com/adyen/model/checkout/UpdatePaymentLinkRequest.java +++ b/src/main/java/com/adyen/model/checkout/UpdatePaymentLinkRequest.java @@ -92,6 +92,11 @@ public StatusEnum getStatus() { } + /** + * Status of the payment link. Possible values: * **expired** + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/checkout/UpiCollectDetails.java b/src/main/java/com/adyen/model/checkout/UpiCollectDetails.java index b813f97b6..e1091dd20 100644 --- a/src/main/java/com/adyen/model/checkout/UpiCollectDetails.java +++ b/src/main/java/com/adyen/model/checkout/UpiCollectDetails.java @@ -116,6 +116,11 @@ public String getBillingSequenceNumber() { } + /** + * The sequence number for the debit. For example, send **2** if this is the second debit for the subscription. The sequence number is included in the notification sent to the shopper. + * + * @param billingSequenceNumber + */ @JsonProperty(JSON_PROPERTY_BILLING_SEQUENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingSequenceNumber(String billingSequenceNumber) { @@ -141,6 +146,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -168,6 +178,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -194,6 +209,11 @@ public String getShopperNotificationReference() { } + /** + * The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. + * + * @param shopperNotificationReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperNotificationReference(String shopperNotificationReference) { @@ -219,6 +239,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -244,6 +269,11 @@ public TypeEnum getType() { } + /** + * **upi_collect** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -269,6 +299,11 @@ public String getVirtualPaymentAddress() { } + /** + * The virtual payment address for UPI. + * + * @param virtualPaymentAddress + */ @JsonProperty(JSON_PROPERTY_VIRTUAL_PAYMENT_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVirtualPaymentAddress(String virtualPaymentAddress) { diff --git a/src/main/java/com/adyen/model/checkout/UpiIntentDetails.java b/src/main/java/com/adyen/model/checkout/UpiIntentDetails.java index 488ca7d23..b2b3cf1fc 100644 --- a/src/main/java/com/adyen/model/checkout/UpiIntentDetails.java +++ b/src/main/java/com/adyen/model/checkout/UpiIntentDetails.java @@ -108,6 +108,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -135,6 +140,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -161,6 +171,11 @@ public String getShopperNotificationReference() { } + /** + * The `shopperNotificationReference` returned in the response when you requested to notify the shopper. Used for recurring payment only. + * + * @param shopperNotificationReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperNotificationReference(String shopperNotificationReference) { @@ -186,6 +201,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -211,6 +231,11 @@ public TypeEnum getType() { } + /** + * **upi_intent** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/UtilityRequest.java b/src/main/java/com/adyen/model/checkout/UtilityRequest.java index da33c7d56..cdc9eeb38 100644 --- a/src/main/java/com/adyen/model/checkout/UtilityRequest.java +++ b/src/main/java/com/adyen/model/checkout/UtilityRequest.java @@ -66,6 +66,11 @@ public List getOriginDomains() { } + /** + * The list of origin domains, for which origin keys are requested. + * + * @param originDomains + */ @JsonProperty(JSON_PROPERTY_ORIGIN_DOMAINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginDomains(List originDomains) { diff --git a/src/main/java/com/adyen/model/checkout/UtilityResponse.java b/src/main/java/com/adyen/model/checkout/UtilityResponse.java index 79a8c2c36..6db1d95ee 100644 --- a/src/main/java/com/adyen/model/checkout/UtilityResponse.java +++ b/src/main/java/com/adyen/model/checkout/UtilityResponse.java @@ -70,6 +70,11 @@ public Map getOriginKeys() { } + /** + * The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key. + * + * @param originKeys + */ @JsonProperty(JSON_PROPERTY_ORIGIN_KEYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginKeys(Map originKeys) { diff --git a/src/main/java/com/adyen/model/checkout/VippsDetails.java b/src/main/java/com/adyen/model/checkout/VippsDetails.java index 59b10d044..0a0dc9448 100644 --- a/src/main/java/com/adyen/model/checkout/VippsDetails.java +++ b/src/main/java/com/adyen/model/checkout/VippsDetails.java @@ -108,6 +108,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -135,6 +140,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -161,6 +171,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -186,6 +201,11 @@ public String getTelephoneNumber() { } + /** + * + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -211,6 +231,11 @@ public TypeEnum getType() { } + /** + * **vipps** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/VisaCheckoutDetails.java b/src/main/java/com/adyen/model/checkout/VisaCheckoutDetails.java index 7aee3373c..0c5f96b73 100644 --- a/src/main/java/com/adyen/model/checkout/VisaCheckoutDetails.java +++ b/src/main/java/com/adyen/model/checkout/VisaCheckoutDetails.java @@ -139,6 +139,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -164,6 +169,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -189,6 +199,11 @@ public TypeEnum getType() { } + /** + * **visacheckout** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -214,6 +229,11 @@ public String getVisaCheckoutCallId() { } + /** + * The Visa Click to Pay Call ID value. When your shopper selects a payment and/or a shipping address from Visa Click to Pay, you will receive a Visa Click to Pay Call ID. + * + * @param visaCheckoutCallId + */ @JsonProperty(JSON_PROPERTY_VISA_CHECKOUT_CALL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisaCheckoutCallId(String visaCheckoutCallId) { diff --git a/src/main/java/com/adyen/model/checkout/WeChatPayDetails.java b/src/main/java/com/adyen/model/checkout/WeChatPayDetails.java index 45cd656ed..303f64a10 100644 --- a/src/main/java/com/adyen/model/checkout/WeChatPayDetails.java +++ b/src/main/java/com/adyen/model/checkout/WeChatPayDetails.java @@ -98,6 +98,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * **wechatpay** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/WeChatPayMiniProgramDetails.java b/src/main/java/com/adyen/model/checkout/WeChatPayMiniProgramDetails.java index 9ed1bf233..3b8679465 100644 --- a/src/main/java/com/adyen/model/checkout/WeChatPayMiniProgramDetails.java +++ b/src/main/java/com/adyen/model/checkout/WeChatPayMiniProgramDetails.java @@ -104,6 +104,11 @@ public String getAppId() { } + /** + * appId + * + * @param appId + */ @JsonProperty(JSON_PROPERTY_APP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAppId(String appId) { @@ -129,6 +134,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -154,6 +164,11 @@ public String getOpenid() { } + /** + * openid + * + * @param openid + */ @JsonProperty(JSON_PROPERTY_OPENID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpenid(String openid) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **wechatpayMiniProgram** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/checkout/ZipDetails.java b/src/main/java/com/adyen/model/checkout/ZipDetails.java index e46f75429..f4aae3b58 100644 --- a/src/main/java/com/adyen/model/checkout/ZipDetails.java +++ b/src/main/java/com/adyen/model/checkout/ZipDetails.java @@ -110,6 +110,11 @@ public String getCheckoutAttemptId() { } + /** + * The checkout attempt identifier. + * + * @param checkoutAttemptId + */ @JsonProperty(JSON_PROPERTY_CHECKOUT_ATTEMPT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckoutAttemptId(String checkoutAttemptId) { @@ -135,6 +140,11 @@ public String getClickAndCollect() { } + /** + * Set this to **true** if the shopper would like to pick up and collect their order, instead of having the goods delivered to them. + * + * @param clickAndCollect + */ @JsonProperty(JSON_PROPERTY_CLICK_AND_COLLECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClickAndCollect(String clickAndCollect) { @@ -162,6 +172,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @Deprecated @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -188,6 +203,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { @@ -213,6 +233,11 @@ public TypeEnum getType() { } + /** + * **zip** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolder.java b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolder.java index 14ca65427..41213e7e0 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolder.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolder.java @@ -153,6 +153,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the [balance platform](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balancePlatforms/{id}__queryParam_id) to which the account holder belongs. Required in the request if your API credentials can be used for multiple balance platforms. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -186,6 +191,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that an account holder can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing. The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -211,6 +221,11 @@ public ContactDetails getContactDetails() { } + /** + * contactDetails + * + * @param contactDetails + */ @JsonProperty(JSON_PROPERTY_CONTACT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContactDetails(ContactDetails contactDetails) { @@ -236,6 +251,11 @@ public String getDescription() { } + /** + * Your description for the account holder, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -261,6 +281,11 @@ public String getId() { } + /** + * The unique identifier of the account holder. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -286,6 +311,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) associated with the account holder. Adyen performs a verification process against the legal entity of the account holder. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -319,6 +349,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -344,6 +379,11 @@ public String getMigratedAccountHolderCode() { } + /** + * The unique identifier of the migrated account holder in the classic integration. + * + * @param migratedAccountHolderCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_HOLDER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountHolderCode(String migratedAccountHolderCode) { @@ -369,6 +409,11 @@ public String getPrimaryBalanceAccount() { } + /** + * The ID of the account holder's primary balance account. By default, this is set to the first balance account that you create for the account holder. To assign a different balance account, send a PATCH request. + * + * @param primaryBalanceAccount + */ @JsonProperty(JSON_PROPERTY_PRIMARY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimaryBalanceAccount(String primaryBalanceAccount) { @@ -394,6 +439,11 @@ public String getReference() { } + /** + * Your reference for the account holder, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -419,6 +469,11 @@ public StatusEnum getStatus() { } + /** + * The status of the account holder. Possible values: * **Active**: The account holder is active. This is the default status when creating an account holder. * **Inactive (Deprecated)**: The account holder is temporarily inactive due to missing KYC details. You can set the account back to active by providing the missing KYC details. * **Suspended**: The account holder is permanently deactivated by Adyen. This action cannot be undone. * **Closed**: The account holder is permanently deactivated by you. This action cannot be undone. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -444,6 +499,11 @@ public String getTimeZone() { } + /** + * The time zone of the account holder. For example, **Europe/Amsterdam**. Defaults to the time zone of the balance platform if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { @@ -477,6 +537,11 @@ public List getVerificationDeadlines() { } + /** + * List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved. + * + * @param verificationDeadlines + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationDeadlines(List verificationDeadlines) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderCapability.java b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderCapability.java index ae453fbf1..d556c9e7d 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderCapability.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderCapability.java @@ -217,6 +217,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -242,6 +247,11 @@ public AllowedLevelEnum getAllowedLevel() { } + /** + * The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param allowedLevel + */ @JsonProperty(JSON_PROPERTY_ALLOWED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedLevel(AllowedLevelEnum allowedLevel) { @@ -267,6 +277,11 @@ public CapabilitySettings getAllowedSettings() { } + /** + * allowedSettings + * + * @param allowedSettings + */ @JsonProperty(JSON_PROPERTY_ALLOWED_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedSettings(CapabilitySettings allowedSettings) { @@ -292,6 +307,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -325,6 +345,11 @@ public List getProblems() { } + /** + * Contains verification errors and the actions that you can take to resolve them. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { @@ -350,6 +375,11 @@ public Boolean getRequested() { } + /** + * Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -375,6 +405,11 @@ public RequestedLevelEnum getRequestedLevel() { } + /** + * The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param requestedLevel + */ @JsonProperty(JSON_PROPERTY_REQUESTED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedLevel(RequestedLevelEnum requestedLevel) { @@ -400,6 +435,11 @@ public CapabilitySettings getRequestedSettings() { } + /** + * requestedSettings + * + * @param requestedSettings + */ @JsonProperty(JSON_PROPERTY_REQUESTED_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedSettings(CapabilitySettings requestedSettings) { @@ -433,6 +473,11 @@ public List getTransferInstruments() { } + /** + * Contains the status of the transfer instruments associated with this capability. + * + * @param transferInstruments + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstruments(List transferInstruments) { @@ -458,6 +503,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * The status of the verification checks for the capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationData.java b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationData.java index 819e987fa..5990c3124 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationData.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationData.java @@ -64,6 +64,11 @@ public AccountHolder getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(AccountHolder accountHolder) { @@ -89,6 +94,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationRequest.java b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationRequest.java index 920cff05b..93cc78acf 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationRequest.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/AccountHolderNotificationRequest.java @@ -103,6 +103,11 @@ public AccountHolderNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(AccountHolderNotificationData data) { @@ -128,6 +133,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -153,6 +163,11 @@ public TypeEnum getType() { } + /** + * Type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/AccountSupportingEntityCapability.java b/src/main/java/com/adyen/model/configurationwebhooks/AccountSupportingEntityCapability.java index a69065e02..e88c68b6f 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/AccountSupportingEntityCapability.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/AccountSupportingEntityCapability.java @@ -200,6 +200,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the supporting entity capability is allowed. Adyen sets this to **true** if the verification is successful and the account holder is permitted to use the capability. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -225,6 +230,11 @@ public AllowedLevelEnum getAllowedLevel() { } + /** + * The capability level that is allowed for the account holder. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param allowedLevel + */ @JsonProperty(JSON_PROPERTY_ALLOWED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedLevel(AllowedLevelEnum allowedLevel) { @@ -250,6 +260,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the capability is enabled. If **false**, the capability is temporarily disabled for the account holder. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -275,6 +290,11 @@ public String getId() { } + /** + * The ID of the supporting entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -300,6 +320,11 @@ public Boolean getRequested() { } + /** + * Indicates whether the capability is requested. To check whether the account holder is permitted to use the capability, refer to the `allowed` field. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -325,6 +350,11 @@ public RequestedLevelEnum getRequestedLevel() { } + /** + * The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param requestedLevel + */ @JsonProperty(JSON_PROPERTY_REQUESTED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedLevel(RequestedLevelEnum requestedLevel) { @@ -350,6 +380,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * The status of the verification checks for the supporting entity capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Address.java b/src/main/java/com/adyen/model/configurationwebhooks/Address.java index 2344efe6a..eadb96792 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Address.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -154,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -179,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -204,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Amount.java b/src/main/java/com/adyen/model/configurationwebhooks/Amount.java index 0cb668e2f..aba5b657c 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Amount.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Authentication.java b/src/main/java/com/adyen/model/configurationwebhooks/Authentication.java index 3e187be54..4062e75d3 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Authentication.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Authentication.java @@ -68,6 +68,11 @@ public String getEmail() { } + /** + * The email address where the one-time password (OTP) is sent. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -93,6 +98,11 @@ public String getPassword() { } + /** + * The password used for 3D Secure password-based authentication. The value must be between 1 to 30 characters and must only contain the following supported characters. * Characters between **a-z**, **A-Z**, and **0-9** * Special characters: **äöüßÄÖÜ+-*_/ç%()=?!~#'\",;:$&àùòâôûáúó** + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -118,6 +128,11 @@ public Phone getPhone() { } + /** + * phone + * + * @param phone + */ @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhone(Phone phone) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Balance.java b/src/main/java/com/adyen/model/configurationwebhooks/Balance.java index e3e6e70f1..7df75b11a 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Balance.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Balance.java @@ -75,6 +75,11 @@ public Long getAvailable() { } + /** + * The remaining amount available for spending. + * + * @param available + */ @JsonProperty(JSON_PROPERTY_AVAILABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvailable(Long available) { @@ -100,6 +105,11 @@ public Long getBalance() { } + /** + * The total amount in the balance. + * + * @param balance + */ @JsonProperty(JSON_PROPERTY_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalance(Long balance) { @@ -125,6 +135,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -150,6 +165,11 @@ public Long getPending() { } + /** + * The amount pending to be paid out but not yet available in the balance. + * + * @param pending + */ @JsonProperty(JSON_PROPERTY_PENDING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPending(Long pending) { @@ -175,6 +195,11 @@ public Long getReserved() { } + /** + * The amount reserved for payments that have been authorised, but have not been captured yet. + * + * @param reserved + */ @JsonProperty(JSON_PROPERTY_RESERVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReserved(Long reserved) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccount.java b/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccount.java index 78c6114ab..041362237 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccount.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccount.java @@ -149,6 +149,11 @@ public String getAccountHolderId() { } + /** + * The unique identifier of the [account holder](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/accountHolders__resParam_id) associated with the balance account. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -182,6 +187,11 @@ public List getBalances() { } + /** + * List of balances with the amount and currency. + * + * @param balances + */ @JsonProperty(JSON_PROPERTY_BALANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalances(List balances) { @@ -207,6 +217,11 @@ public String getDefaultCurrencyCode() { } + /** + * The default three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) of the balance account. The default value is **EUR**. > After a balance account is created, you cannot change its default currency. + * + * @param defaultCurrencyCode + */ @JsonProperty(JSON_PROPERTY_DEFAULT_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultCurrencyCode(String defaultCurrencyCode) { @@ -232,6 +247,11 @@ public String getDescription() { } + /** + * A human-readable description of the balance account, maximum 300 characters. You can use this parameter to distinguish between multiple balance accounts under an account holder. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -257,6 +277,11 @@ public String getId() { } + /** + * The unique identifier of the balance account. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -290,6 +315,11 @@ public Map getMetadata() { } + /** + * A set of key and value pairs for general use. The keys do not have specific names and may be used for storing miscellaneous data as desired. > Note that during an update of metadata, the omission of existing key-value pairs will result in the deletion of those key-value pairs. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -315,6 +345,11 @@ public String getMigratedAccountCode() { } + /** + * The unique identifier of the account of the migrated account holder in the classic integration. + * + * @param migratedAccountCode + */ @JsonProperty(JSON_PROPERTY_MIGRATED_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMigratedAccountCode(String migratedAccountCode) { @@ -348,6 +383,11 @@ public List getPaymentInstruments() { } + /** + * List of [payment instruments](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments) associated with the balance account. + * + * @param paymentInstruments + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstruments(List paymentInstruments) { @@ -373,6 +413,11 @@ public PlatformPaymentConfiguration getPlatformPaymentConfiguration() { } + /** + * platformPaymentConfiguration + * + * @param platformPaymentConfiguration + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentConfiguration(PlatformPaymentConfiguration platformPaymentConfiguration) { @@ -398,6 +443,11 @@ public String getReference() { } + /** + * Your reference for the balance account, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -423,6 +473,11 @@ public StatusEnum getStatus() { } + /** + * The status of the balance account, set to **Active** by default. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -448,6 +503,11 @@ public String getTimeZone() { } + /** + * The time zone of the balance account. For example, **Europe/Amsterdam**. Defaults to the time zone of the account holder if no time zone is set. For possible values, see the [list of time zone codes](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + * + * @param timeZone + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZone(String timeZone) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationData.java b/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationData.java index f434f1222..d5c088401 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationData.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationData.java @@ -64,6 +64,11 @@ public BalanceAccount getBalanceAccount() { } + /** + * balanceAccount + * + * @param balanceAccount + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccount(BalanceAccount balanceAccount) { @@ -89,6 +94,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationRequest.java b/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationRequest.java index d1dc205e1..3f9e1f05b 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationRequest.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/BalanceAccountNotificationRequest.java @@ -103,6 +103,11 @@ public BalanceAccountNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(BalanceAccountNotificationData data) { @@ -128,6 +133,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -153,6 +163,11 @@ public TypeEnum getType() { } + /** + * Type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/BalancePlatformNotificationResponse.java b/src/main/java/com/adyen/model/configurationwebhooks/BalancePlatformNotificationResponse.java index 2d3e1c609..aafd42c3f 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/BalancePlatformNotificationResponse.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/BalancePlatformNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/BulkAddress.java b/src/main/java/com/adyen/model/configurationwebhooks/BulkAddress.java index 6b725fdd2..3d2a0ec2f 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/BulkAddress.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/BulkAddress.java @@ -91,6 +91,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -116,6 +121,11 @@ public String getCompany() { } + /** + * The name of the company. + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(String company) { @@ -141,6 +151,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -166,6 +181,11 @@ public String getEmail() { } + /** + * The email address. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -191,6 +211,11 @@ public String getHouseNumberOrName() { } + /** + * The house number or name. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -216,6 +241,11 @@ public String getMobile() { } + /** + * The full telephone number. + * + * @param mobile + */ @JsonProperty(JSON_PROPERTY_MOBILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMobile(String mobile) { @@ -241,6 +271,11 @@ public String getPostalCode() { } + /** + * The postal code. Maximum length: * 5 digits for addresses in the US. * 10 characters for all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -266,6 +301,11 @@ public String getStateOrProvince() { } + /** + * The two-letter ISO 3166-2 state or province code. Maximum length: 2 characters for addresses in the US. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -291,6 +331,11 @@ public String getStreet() { } + /** + * The streetname of the house. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblem.java b/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblem.java index ee5955812..d12a156a9 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblem.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblem.java @@ -67,6 +67,11 @@ public CapabilityProblemEntity getEntity() { } + /** + * entity + * + * @param entity + */ @JsonProperty(JSON_PROPERTY_ENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntity(CapabilityProblemEntity entity) { @@ -100,6 +105,11 @@ public List getVerificationErrors() { } + /** + * Contains information about the verification error. + * + * @param verificationErrors + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationErrors(List verificationErrors) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntity.java b/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntity.java index 435d65db9..42d08bda0 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntity.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntity.java @@ -119,6 +119,11 @@ public List getDocuments() { } + /** + * List of document IDs to which the verification errors related to the capabilities correspond to. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -144,6 +149,11 @@ public String getId() { } + /** + * The ID of the entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -169,6 +179,11 @@ public CapabilityProblemEntityRecursive getOwner() { } + /** + * owner + * + * @param owner + */ @JsonProperty(JSON_PROPERTY_OWNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwner(CapabilityProblemEntityRecursive owner) { @@ -194,6 +209,11 @@ public TypeEnum getType() { } + /** + * Type of entity. Possible values: **LegalEntity**, **BankAccount**, **Document**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntityRecursive.java b/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntityRecursive.java index ae4170d8e..a36fb9234 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntityRecursive.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CapabilityProblemEntityRecursive.java @@ -115,6 +115,11 @@ public List getDocuments() { } + /** + * List of document IDs to which the verification errors related to the capabilities correspond to. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -140,6 +145,11 @@ public String getId() { } + /** + * The ID of the entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -165,6 +175,11 @@ public TypeEnum getType() { } + /** + * Type of entity. Possible values: **LegalEntity**, **BankAccount**, **Document**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CapabilitySettings.java b/src/main/java/com/adyen/model/configurationwebhooks/CapabilitySettings.java index 80d972d6d..1444ff31d 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CapabilitySettings.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CapabilitySettings.java @@ -162,6 +162,11 @@ public Map getAmountPerIndustry() { } + /** + * + * + * @param amountPerIndustry + */ @JsonProperty(JSON_PROPERTY_AMOUNT_PER_INDUSTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountPerIndustry(Map amountPerIndustry) { @@ -187,6 +192,11 @@ public Boolean getAuthorizedCardUsers() { } + /** + * + * + * @param authorizedCardUsers + */ @JsonProperty(JSON_PROPERTY_AUTHORIZED_CARD_USERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorizedCardUsers(Boolean authorizedCardUsers) { @@ -220,6 +230,11 @@ public List getFundingSource() { } + /** + * + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(List fundingSource) { @@ -245,6 +260,11 @@ public IntervalEnum getInterval() { } + /** + * + * + * @param interval + */ @JsonProperty(JSON_PROPERTY_INTERVAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterval(IntervalEnum interval) { @@ -270,6 +290,11 @@ public Amount getMaxAmount() { } + /** + * maxAmount + * + * @param maxAmount + */ @JsonProperty(JSON_PROPERTY_MAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxAmount(Amount maxAmount) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Card.java b/src/main/java/com/adyen/model/configurationwebhooks/Card.java index 5207d8975..b5b79cfbc 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Card.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Card.java @@ -148,6 +148,11 @@ public Authentication getAuthentication() { } + /** + * authentication + * + * @param authentication + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthentication(Authentication authentication) { @@ -173,6 +178,11 @@ public String getBin() { } + /** + * The bank identification number (BIN) of the card number. + * + * @param bin + */ @JsonProperty(JSON_PROPERTY_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBin(String bin) { @@ -198,6 +208,11 @@ public String getBrand() { } + /** + * The brand of the physical or the virtual card. Possible values: **visa**, **mc**. + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -223,6 +238,11 @@ public String getBrandVariant() { } + /** + * The brand variant of the physical or the virtual card. For example, **visadebit** or **mcprepaid**. >Reach out to your Adyen contact to get the values relevant for your integration. + * + * @param brandVariant + */ @JsonProperty(JSON_PROPERTY_BRAND_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrandVariant(String brandVariant) { @@ -248,6 +268,11 @@ public String getCardholderName() { } + /** + * The name of the cardholder. Maximum length: 26 characters. + * + * @param cardholderName + */ @JsonProperty(JSON_PROPERTY_CARDHOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardholderName(String cardholderName) { @@ -273,6 +298,11 @@ public CardConfiguration getConfiguration() { } + /** + * configuration + * + * @param configuration + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfiguration(CardConfiguration configuration) { @@ -298,6 +328,11 @@ public String getCvc() { } + /** + * The CVC2 value of the card. > The CVC2 is not sent by default. This is only returned in the `POST` response for single-use virtual cards. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -323,6 +358,11 @@ public Contact getDeliveryContact() { } + /** + * deliveryContact + * + * @param deliveryContact + */ @JsonProperty(JSON_PROPERTY_DELIVERY_CONTACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryContact(Contact deliveryContact) { @@ -348,6 +388,11 @@ public Expiry getExpiration() { } + /** + * expiration + * + * @param expiration + */ @JsonProperty(JSON_PROPERTY_EXPIRATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiration(Expiry expiration) { @@ -373,6 +418,11 @@ public FormFactorEnum getFormFactor() { } + /** + * The form factor of the card. Possible values: **virtual**, **physical**. + * + * @param formFactor + */ @JsonProperty(JSON_PROPERTY_FORM_FACTOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFormFactor(FormFactorEnum formFactor) { @@ -398,6 +448,11 @@ public String getLastFour() { } + /** + * Last last four digits of the card number. + * + * @param lastFour + */ @JsonProperty(JSON_PROPERTY_LAST_FOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastFour(String lastFour) { @@ -423,6 +478,11 @@ public String getNumber() { } + /** + * The primary account number (PAN) of the card. > The PAN is masked by default and returned only for single-use virtual cards. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -448,6 +508,11 @@ public String getThreeDSecure() { } + /** + * Allocates a specific product range for either a physical or a virtual card. Possible values: **fullySupported**, **secureCorporate**. >Reach out to your Adyen contact to get the values relevant for your integration. + * + * @param threeDSecure + */ @JsonProperty(JSON_PROPERTY_THREE_D_SECURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSecure(String threeDSecure) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CardConfiguration.java b/src/main/java/com/adyen/model/configurationwebhooks/CardConfiguration.java index 24bb73c0c..e2bd5306d 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CardConfiguration.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CardConfiguration.java @@ -112,6 +112,11 @@ public String getActivation() { } + /** + * Overrides the activation label design ID defined in the `configurationProfileId`. The activation label is attached to the card and contains the activation instructions. + * + * @param activation + */ @JsonProperty(JSON_PROPERTY_ACTIVATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActivation(String activation) { @@ -137,6 +142,11 @@ public String getActivationUrl() { } + /** + * Your app's URL, if you want to activate cards through your app. For example, **my-app://ref1236a7d**. A QR code is created based on this URL, and is included in the carrier. Before you use this field, reach out to your Adyen contact to set up the QR code process. Maximum length: 255 characters. + * + * @param activationUrl + */ @JsonProperty(JSON_PROPERTY_ACTIVATION_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActivationUrl(String activationUrl) { @@ -162,6 +172,11 @@ public BulkAddress getBulkAddress() { } + /** + * bulkAddress + * + * @param bulkAddress + */ @JsonProperty(JSON_PROPERTY_BULK_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBulkAddress(BulkAddress bulkAddress) { @@ -187,6 +202,11 @@ public String getCardImageId() { } + /** + * The ID of the card image. This is the image that will be printed on the full front of the card. + * + * @param cardImageId + */ @JsonProperty(JSON_PROPERTY_CARD_IMAGE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardImageId(String cardImageId) { @@ -212,6 +232,11 @@ public String getCarrier() { } + /** + * Overrides the carrier design ID defined in the `configurationProfileId`. The carrier is the letter or packaging to which the card is attached. + * + * @param carrier + */ @JsonProperty(JSON_PROPERTY_CARRIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarrier(String carrier) { @@ -237,6 +262,11 @@ public String getCarrierImageId() { } + /** + * The ID of the carrier image. This is the image that will printed on the letter to which the card is attached. + * + * @param carrierImageId + */ @JsonProperty(JSON_PROPERTY_CARRIER_IMAGE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarrierImageId(String carrierImageId) { @@ -262,6 +292,11 @@ public String getConfigurationProfileId() { } + /** + * The ID of the card configuration profile that contains the settings of the card. For example, the envelope and PIN mailer designs or the logistics company handling the shipment. All the settings in the profile are applied to the card, unless you provide other fields to override them. For example, send the `shipmentMethod` to override the logistics company defined in the card configuration profile. + * + * @param configurationProfileId + */ @JsonProperty(JSON_PROPERTY_CONFIGURATION_PROFILE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfigurationProfileId(String configurationProfileId) { @@ -287,6 +322,11 @@ public String getCurrency() { } + /** + * The three-letter [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the card. For example, **EUR**. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -312,6 +352,11 @@ public String getEnvelope() { } + /** + * Overrides the envelope design ID defined in the `configurationProfileId`. + * + * @param envelope + */ @JsonProperty(JSON_PROPERTY_ENVELOPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvelope(String envelope) { @@ -337,6 +382,11 @@ public String getInsert() { } + /** + * Overrides the insert design ID defined in the `configurationProfileId`. An insert is any additional material, such as marketing materials, that are shipped together with the card. + * + * @param insert + */ @JsonProperty(JSON_PROPERTY_INSERT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInsert(String insert) { @@ -362,6 +412,11 @@ public String getLanguage() { } + /** + * The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code of the card. For example, **en**. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -387,6 +442,11 @@ public String getLogoImageId() { } + /** + * The ID of the logo image. This is the image that will be printed on the partial front of the card, such as a logo on the upper right corner. + * + * @param logoImageId + */ @JsonProperty(JSON_PROPERTY_LOGO_IMAGE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLogoImageId(String logoImageId) { @@ -412,6 +472,11 @@ public String getPinMailer() { } + /** + * Overrides the PIN mailer design ID defined in the `configurationProfileId`. The PIN mailer is the letter on which the PIN is printed. + * + * @param pinMailer + */ @JsonProperty(JSON_PROPERTY_PIN_MAILER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPinMailer(String pinMailer) { @@ -437,6 +502,11 @@ public String getShipmentMethod() { } + /** + * Overrides the logistics company defined in the `configurationProfileId`. + * + * @param shipmentMethod + */ @JsonProperty(JSON_PROPERTY_SHIPMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipmentMethod(String shipmentMethod) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItem.java b/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItem.java index 86aebb429..df13ff8f4 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItem.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItem.java @@ -89,6 +89,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -114,6 +119,11 @@ public CardOrderItemDeliveryStatus getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(CardOrderItemDeliveryStatus card) { @@ -139,6 +149,11 @@ public String getCardOrderItemId() { } + /** + * The unique identifier of the card order item. + * + * @param cardOrderItemId + */ @JsonProperty(JSON_PROPERTY_CARD_ORDER_ITEM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardOrderItemId(String cardOrderItemId) { @@ -164,6 +179,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -189,6 +209,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -214,6 +239,11 @@ public String getPaymentInstrumentId() { } + /** + * The unique identifier of the payment instrument related to the card order item. + * + * @param paymentInstrumentId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentId(String paymentInstrumentId) { @@ -239,6 +269,11 @@ public CardOrderItemDeliveryStatus getPin() { } + /** + * pin + * + * @param pin + */ @JsonProperty(JSON_PROPERTY_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPin(CardOrderItemDeliveryStatus pin) { @@ -264,6 +299,11 @@ public String getShippingMethod() { } + /** + * Shipping method used to deliver the card or the PIN. + * + * @param shippingMethod + */ @JsonProperty(JSON_PROPERTY_SHIPPING_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShippingMethod(String shippingMethod) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItemDeliveryStatus.java b/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItemDeliveryStatus.java index 071bfb78a..8f0bcfc96 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItemDeliveryStatus.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CardOrderItemDeliveryStatus.java @@ -114,6 +114,11 @@ public String getErrorMessage() { } + /** + * Error message. + * + * @param errorMessage + */ @JsonProperty(JSON_PROPERTY_ERROR_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorMessage(String errorMessage) { @@ -139,6 +144,11 @@ public StatusEnum getStatus() { } + /** + * Status of the delivery. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -164,6 +174,11 @@ public String getTrackingNumber() { } + /** + * Tracking number of the delivery. + * + * @param trackingNumber + */ @JsonProperty(JSON_PROPERTY_TRACKING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrackingNumber(String trackingNumber) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/CardOrderNotificationRequest.java b/src/main/java/com/adyen/model/configurationwebhooks/CardOrderNotificationRequest.java index 1de1e7444..83b721d50 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/CardOrderNotificationRequest.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/CardOrderNotificationRequest.java @@ -103,6 +103,11 @@ public CardOrderItem getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(CardOrderItem data) { @@ -128,6 +133,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -153,6 +163,11 @@ public TypeEnum getType() { } + /** + * Type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Contact.java b/src/main/java/com/adyen/model/configurationwebhooks/Contact.java index 27affac11..220e037ae 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Contact.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Contact.java @@ -87,6 +87,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -112,6 +117,11 @@ public String getEmail() { } + /** + * The e-mail address of the contact. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -137,6 +147,11 @@ public String getFullPhoneNumber() { } + /** + * The phone number of the contact provided as a single string. It will be handled as a landline phone. **Examples:** \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\" + * + * @param fullPhoneNumber + */ @JsonProperty(JSON_PROPERTY_FULL_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFullPhoneNumber(String fullPhoneNumber) { @@ -162,6 +177,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -187,6 +207,11 @@ public PersonalData getPersonalData() { } + /** + * personalData + * + * @param personalData + */ @JsonProperty(JSON_PROPERTY_PERSONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPersonalData(PersonalData personalData) { @@ -212,6 +237,11 @@ public PhoneNumber getPhoneNumber() { } + /** + * phoneNumber + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(PhoneNumber phoneNumber) { @@ -237,6 +267,11 @@ public String getWebAddress() { } + /** + * The URL of the website of the contact. + * + * @param webAddress + */ @JsonProperty(JSON_PROPERTY_WEB_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebAddress(String webAddress) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/ContactDetails.java b/src/main/java/com/adyen/model/configurationwebhooks/ContactDetails.java index 33f455108..a0c5f7176 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/ContactDetails.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/ContactDetails.java @@ -73,6 +73,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -98,6 +103,11 @@ public String getEmail() { } + /** + * The email address of the account holder. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -123,6 +133,11 @@ public Phone getPhone() { } + /** + * phone + * + * @param phone + */ @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhone(Phone phone) { @@ -148,6 +163,11 @@ public String getWebAddress() { } + /** + * The URL of the account holder's website. + * + * @param webAddress + */ @JsonProperty(JSON_PROPERTY_WEB_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebAddress(String webAddress) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Expiry.java b/src/main/java/com/adyen/model/configurationwebhooks/Expiry.java index cf7239bda..ad4c99cad 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Expiry.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Expiry.java @@ -63,6 +63,11 @@ public String getMonth() { } + /** + * The month in which the card will expire. + * + * @param month + */ @JsonProperty(JSON_PROPERTY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMonth(String month) { @@ -88,6 +93,11 @@ public String getYear() { } + /** + * The year in which the card will expire. + * + * @param year + */ @JsonProperty(JSON_PROPERTY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setYear(String year) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/IbanAccountIdentification.java b/src/main/java/com/adyen/model/configurationwebhooks/IbanAccountIdentification.java index 2fd391f69..22479ebea 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/IbanAccountIdentification.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/IbanAccountIdentification.java @@ -96,6 +96,11 @@ public String getIban() { } + /** + * The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **iban** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Name.java b/src/main/java/com/adyen/model/configurationwebhooks/Name.java index 2ad4cc75c..d02e06929 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Name.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Name.java @@ -63,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -88,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrument.java b/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrument.java index 5bdac06c0..e5b39b88e 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrument.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrument.java @@ -181,6 +181,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/balanceAccounts__resParam_id) associated with the payment instrument. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -206,6 +211,11 @@ public PaymentInstrumentBankAccount getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(PaymentInstrumentBankAccount bankAccount) { @@ -231,6 +241,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -256,6 +271,11 @@ public String getDescription() { } + /** + * Your description for the payment instrument, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -281,6 +301,11 @@ public String getId() { } + /** + * The unique identifier of the payment instrument. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -306,6 +331,11 @@ public String getIssuingCountryCode() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the payment instrument is issued. For example, **NL** or **US**. + * + * @param issuingCountryCode + */ @JsonProperty(JSON_PROPERTY_ISSUING_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuingCountryCode(String issuingCountryCode) { @@ -331,6 +361,11 @@ public String getPaymentInstrumentGroupId() { } + /** + * The unique identifier of the [payment instrument group](https://docs.adyen.com/api-explorer/#/balanceplatform/v1/post/paymentInstrumentGroups__resParam_id) to which the payment instrument belongs. + * + * @param paymentInstrumentGroupId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_GROUP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentGroupId(String paymentInstrumentGroupId) { @@ -356,6 +391,11 @@ public String getReference() { } + /** + * Your reference for the payment instrument, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -381,6 +421,11 @@ public StatusEnum getStatus() { } + /** + * The status of the payment instrument. If a status is not specified when creating a payment instrument, it is set to **Active** by default. However, there can be exceptions for cards based on the `card.formFactor` and the `issuingCountryCode`. For example, when issuing physical cards in the US, the default status is **Requested**. Possible values: * **Active**: The payment instrument is active and can be used to make payments. * **Requested**: The payment instrument has been requested. This state is applicable for physical cards. * **Inactive**: The payment instrument is inactive and cannot be used to make payments. * **Suspended**: The payment instrument is temporarily suspended and cannot be used to make payments. * **Closed**: The payment instrument is permanently closed. This action cannot be undone. * **Stolen** * **Lost** + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -406,6 +451,11 @@ public TypeEnum getType() { } + /** + * Type of payment instrument. Possible value: **card**, **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentNotificationData.java b/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentNotificationData.java index 7baa8171c..a0b3c41a3 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentNotificationData.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentNotificationData.java @@ -64,6 +64,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -89,6 +94,11 @@ public PaymentInstrument getPaymentInstrument() { } + /** + * paymentInstrument + * + * @param paymentInstrument + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrument(PaymentInstrument paymentInstrument) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentReference.java b/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentReference.java index 65b1dec58..327f489fc 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentReference.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PaymentInstrumentReference.java @@ -59,6 +59,11 @@ public String getId() { } + /** + * The unique identifier of the payment instrument. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PaymentNotificationRequest.java b/src/main/java/com/adyen/model/configurationwebhooks/PaymentNotificationRequest.java index dcb80a6bd..fe7008bd6 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PaymentNotificationRequest.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PaymentNotificationRequest.java @@ -103,6 +103,11 @@ public PaymentInstrumentNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(PaymentInstrumentNotificationData data) { @@ -128,6 +133,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -153,6 +163,11 @@ public TypeEnum getType() { } + /** + * Type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PersonalData.java b/src/main/java/com/adyen/model/configurationwebhooks/PersonalData.java index d6e071492..e11761a1f 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PersonalData.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PersonalData.java @@ -67,6 +67,11 @@ public String getDateOfBirth() { } + /** + * The date of birth of the person. The date should be in ISO-8601 format yyyy-mm-dd (e.g. 2000-01-31). + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(String dateOfBirth) { @@ -92,6 +97,11 @@ public String getIdNumber() { } + /** + * An ID number of the person. + * + * @param idNumber + */ @JsonProperty(JSON_PROPERTY_ID_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdNumber(String idNumber) { @@ -117,6 +127,11 @@ public String getNationality() { } + /** + * The nationality of the person represented by a two-character country code. >The permitted country codes are defined in ISO-3166-1 alpha-2 (e.g. 'NL'). + * + * @param nationality + */ @JsonProperty(JSON_PROPERTY_NATIONALITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationality(String nationality) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Phone.java b/src/main/java/com/adyen/model/configurationwebhooks/Phone.java index fa5b5124b..975a3941d 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Phone.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Phone.java @@ -98,6 +98,11 @@ public String getNumber() { } + /** + * The full phone number provided as a single string. For example, **\"0031 6 11 22 33 44\"**, **\"+316/1122-3344\"**, or **\"(0031) 611223344\"**. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * Type of phone number. Possible values: **Landline**, **Mobile**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PhoneNumber.java b/src/main/java/com/adyen/model/configurationwebhooks/PhoneNumber.java index 31257f01d..03686fa64 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PhoneNumber.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PhoneNumber.java @@ -106,6 +106,11 @@ public String getPhoneCountryCode() { } + /** + * The two-character ISO-3166-1 alpha-2 country code of the phone number. For example, **US** or **NL**. + * + * @param phoneCountryCode + */ @JsonProperty(JSON_PROPERTY_PHONE_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneCountryCode(String phoneCountryCode) { @@ -131,6 +136,11 @@ public String getPhoneNumber() { } + /** + * The phone number. The inclusion of the phone number country code is not necessary. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -156,6 +166,11 @@ public PhoneTypeEnum getPhoneType() { } + /** + * The type of the phone number. Possible values: **Landline**, **Mobile**, **SIP**, **Fax**. + * + * @param phoneType + */ @JsonProperty(JSON_PROPERTY_PHONE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneType(PhoneTypeEnum phoneType) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/PlatformPaymentConfiguration.java b/src/main/java/com/adyen/model/configurationwebhooks/PlatformPaymentConfiguration.java index a4512b4d9..34594af0b 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/PlatformPaymentConfiguration.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/PlatformPaymentConfiguration.java @@ -63,6 +63,11 @@ public String getSalesDayClosingTime() { } + /** + * Specifies at what time a [sales day](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#sales-day) ends. Possible values: Time in **\"HH:MM\"** format. **HH** ranges from **00** to **07**. **MM** must be **00**. Default value: **\"00:00\"**. + * + * @param salesDayClosingTime + */ @JsonProperty(JSON_PROPERTY_SALES_DAY_CLOSING_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSalesDayClosingTime(String salesDayClosingTime) { @@ -88,6 +93,11 @@ public Integer getSettlementDelayDays() { } + /** + * Specifies after how many business days the funds in a [settlement batch](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement#settlement-batch) are made available. Possible values: **0** to **10**, or **null**. * Setting this value to an integer enables [Sales day settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/sales-day-settlement). * Setting this value to **null** enables [Pass-through settlement](https://docs.adyen.com/marketplaces-and-platforms/settle-funds/pass-through-settlement). Default value: **null**. + * + * @param settlementDelayDays + */ @JsonProperty(JSON_PROPERTY_SETTLEMENT_DELAY_DAYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSettlementDelayDays(Integer settlementDelayDays) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/RemediatingAction.java b/src/main/java/com/adyen/model/configurationwebhooks/RemediatingAction.java index 7935a4fcb..f91b7c04c 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/RemediatingAction.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/RemediatingAction.java @@ -63,6 +63,11 @@ public String getCode() { } + /** + * The remediating action code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -88,6 +93,11 @@ public String getMessage() { } + /** + * A description of how you can resolve the verification error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/Resource.java b/src/main/java/com/adyen/model/configurationwebhooks/Resource.java index 6299f4ba5..59cf0f3c1 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/Resource.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/Resource.java @@ -68,6 +68,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -93,6 +98,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationData.java b/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationData.java index 2d9549468..638300de9 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationData.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationData.java @@ -68,6 +68,11 @@ public String getAccountId() { } + /** + * The unique identifier of the balance account for which the sweep was configured. + * + * @param accountId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountId(String accountId) { @@ -93,6 +98,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -118,6 +128,11 @@ public SweepConfigurationV2 getSweep() { } + /** + * sweep + * + * @param sweep + */ @JsonProperty(JSON_PROPERTY_SWEEP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSweep(SweepConfigurationV2 sweep) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationRequest.java b/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationRequest.java index d083f82e8..b5f129eea 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationRequest.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationNotificationRequest.java @@ -105,6 +105,11 @@ public SweepConfigurationNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(SweepConfigurationNotificationData data) { @@ -130,6 +135,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -155,6 +165,11 @@ public TypeEnum getType() { } + /** + * Type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationV2.java b/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationV2.java index 3b850669a..6a50d361e 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationV2.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/SweepConfigurationV2.java @@ -235,6 +235,11 @@ public SweepCounterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(SweepCounterparty counterparty) { @@ -260,6 +265,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes) in uppercase. For example, **EUR**. The sweep currency must match any of the [balances currencies](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__resParam_balances). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -285,6 +295,11 @@ public String getDescription() { } + /** + * The message that will be used in the sweep transfer's description body with a maximum length of 140 characters. If the message is longer after replacing placeholders, the message will be cut off at 140 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -310,6 +325,11 @@ public String getId() { } + /** + * The unique identifier of the sweep. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -335,6 +355,11 @@ public ReasonEnum getReason() { } + /** + * The reason for disabling the sweep. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -360,6 +385,11 @@ public SweepSchedule getSchedule() { } + /** + * schedule + * + * @param schedule + */ @JsonProperty(JSON_PROPERTY_SCHEDULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSchedule(SweepSchedule schedule) { @@ -385,6 +415,11 @@ public StatusEnum getStatus() { } + /** + * The status of the sweep. If not provided, by default, this is set to **active**. Possible values: * **active**: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration. * **inactive**: the sweep is disabled and cannot be triggered. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -410,6 +445,11 @@ public Amount getSweepAmount() { } + /** + * sweepAmount + * + * @param sweepAmount + */ @JsonProperty(JSON_PROPERTY_SWEEP_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSweepAmount(Amount sweepAmount) { @@ -435,6 +475,11 @@ public Amount getTargetAmount() { } + /** + * targetAmount + * + * @param targetAmount + */ @JsonProperty(JSON_PROPERTY_TARGET_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTargetAmount(Amount targetAmount) { @@ -460,6 +505,11 @@ public Amount getTriggerAmount() { } + /** + * triggerAmount + * + * @param triggerAmount + */ @JsonProperty(JSON_PROPERTY_TRIGGER_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTriggerAmount(Amount triggerAmount) { @@ -485,6 +535,11 @@ public TypeEnum getType() { } + /** + * The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to **push**. Possible values: * **push**: _push out funds_ to a destination balance account or transfer instrument. * **pull**: _pull in funds_ from a source merchant account, transfer instrument, or balance account. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/SweepCounterparty.java b/src/main/java/com/adyen/model/configurationwebhooks/SweepCounterparty.java index c54e4575c..f2a8c4695 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/SweepCounterparty.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/SweepCounterparty.java @@ -67,6 +67,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the destination or source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). You can only use this for periodic sweep schedules such as `schedule.type` **daily** or **monthly**. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -92,6 +97,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that will be the source of funds. You can only use this parameter with sweeps of `type` **pull** and `schedule.type` **balance**, and if you are processing payments with Adyen. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -117,6 +127,11 @@ public String getTransferInstrumentId() { } + /** + * The unique identifier of the destination or source [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id) depending on the sweep `type` . To [set up automated top-up sweeps to balance accounts](https://docs.adyen.com/marketplaces-and-platforms/top-up-balance-account/#before-you-begin), use this parameter in combination with a `merchantAccount` and a sweep `type` of **pull**. Top-up sweeps start a direct debit request from the source transfer instrument. Contact Adyen Support to enable this feature. + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/SweepSchedule.java b/src/main/java/com/adyen/model/configurationwebhooks/SweepSchedule.java index 3a752d483..6a287617e 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/SweepSchedule.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/SweepSchedule.java @@ -104,6 +104,11 @@ public String getCronExpression() { } + /** + * A [cron expression](https://en.wikipedia.org/wiki/Cron#CRON_expression) that is used to set the sweep schedule. The schedule uses the time zone of the balance account. For example, **30 17 * * MON** schedules a sweep every Monday at 17:30. The expression must have five values separated by a single space in the following order: * Minute: **0-59** * Hour: **0-23** * Day of the month: **1-31** * Month: **1-12** or **JAN-DEC** * Day of the week: **0-7** (0 and 7 are Sunday) or **MON-SUN**. The following non-standard characters are supported: **&ast;**, **L**, **#**, **W** and **_/_**. See [crontab guru](https://crontab.guru/) for more examples. Required when `type` is **cron**. + * + * @param cronExpression + */ @JsonProperty(JSON_PROPERTY_CRON_EXPRESSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCronExpression(String cronExpression) { @@ -129,6 +134,11 @@ public TypeEnum getType() { } + /** + * The schedule type. Possible values: * **cron**: push out funds based on a `cronExpression`. * **daily**: push out funds daily at 07:00 AM CET. * **weekly**: push out funds every Monday at 07:00 AM CET. * **monthly**: push out funds every first of the month at 07:00 AM CET. * **balance**: pull in funds instantly if the balance is less than or equal to the `triggerAmount`. You can only use this for sweeps of `type` **pull** and when the source is a `merchantAccount` or `transferInstrument`. If the source is transferInstrument, merchant account identifier is still required, with which you want to process the transaction. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/USLocalAccountIdentification.java b/src/main/java/com/adyen/model/configurationwebhooks/USLocalAccountIdentification.java index 143d316e7..fae5af249 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/USLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/USLocalAccountIdentification.java @@ -139,6 +139,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -164,6 +169,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -189,6 +199,11 @@ public String getRoutingNumber() { } + /** + * The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. + * + * @param routingNumber + */ @JsonProperty(JSON_PROPERTY_ROUTING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoutingNumber(String routingNumber) { @@ -214,6 +229,11 @@ public TypeEnum getType() { } + /** + * **usLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/VerificationDeadline.java b/src/main/java/com/adyen/model/configurationwebhooks/VerificationDeadline.java index 7d236fc4f..4b9616799 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/VerificationDeadline.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/VerificationDeadline.java @@ -206,6 +206,11 @@ public List getCapabilities() { } + /** + * The names of the capabilities to be disallowed. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -239,6 +244,11 @@ public List getEntityIds() { } + /** + * The unique identifiers of the bank account(s) that the deadline applies to + * + * @param entityIds + */ @JsonProperty(JSON_PROPERTY_ENTITY_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityIds(List entityIds) { @@ -264,6 +274,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date that verification is due by before capabilities are disallowed. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/VerificationError.java b/src/main/java/com/adyen/model/configurationwebhooks/VerificationError.java index bfdbd6fee..668e61e60 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/VerificationError.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/VerificationError.java @@ -259,6 +259,11 @@ public List getCapabilities() { } + /** + * Contains the capabilities that the verification error applies to. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -284,6 +289,11 @@ public String getCode() { } + /** + * The verification error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -309,6 +319,11 @@ public String getMessage() { } + /** + * A description of the error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -342,6 +357,11 @@ public List getRemediatingActions() { } + /** + * Contains the actions that you can take to resolve the verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { @@ -375,6 +395,11 @@ public List getSubErrors() { } + /** + * Contains more granular information about the verification error. + * + * @param subErrors + */ @JsonProperty(JSON_PROPERTY_SUB_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubErrors(List subErrors) { @@ -400,6 +425,11 @@ public TypeEnum getType() { } + /** + * The type of error. Possible values: **invalidInput**, **dataMissing**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/configurationwebhooks/VerificationErrorRecursive.java b/src/main/java/com/adyen/model/configurationwebhooks/VerificationErrorRecursive.java index 865edf86a..b5bc745d6 100644 --- a/src/main/java/com/adyen/model/configurationwebhooks/VerificationErrorRecursive.java +++ b/src/main/java/com/adyen/model/configurationwebhooks/VerificationErrorRecursive.java @@ -255,6 +255,11 @@ public List getCapabilities() { } + /** + * Contains the capabilities that the verification error applies to. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -280,6 +285,11 @@ public String getCode() { } + /** + * The verification error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -305,6 +315,11 @@ public String getMessage() { } + /** + * A description of the error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -330,6 +345,11 @@ public TypeEnum getType() { } + /** + * The type of error. Possible values: **invalidInput**, **dataMissing**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -363,6 +383,11 @@ public List getRemediatingActions() { } + /** + * Contains the actions that you can take to resolve the verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { diff --git a/src/main/java/com/adyen/model/dataprotection/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/dataprotection/AbstractOpenApiSchema.java index c81d196cb..203e07aa6 100644 --- a/src/main/java/com/adyen/model/dataprotection/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/dataprotection/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Adyen Data Protection API - * Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication Each request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Data Protection Service API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure ``` * * The version of the OpenAPI document: 1 * diff --git a/src/main/java/com/adyen/model/dataprotection/ServiceError.java b/src/main/java/com/adyen/model/dataprotection/ServiceError.java index 36960efca..df294f756 100644 --- a/src/main/java/com/adyen/model/dataprotection/ServiceError.java +++ b/src/main/java/com/adyen/model/dataprotection/ServiceError.java @@ -1,6 +1,5 @@ /* * Adyen Data Protection API - * Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication Each request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Data Protection Service API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure ``` * * The version of the OpenAPI document: 1 * @@ -76,6 +75,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -101,6 +105,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -126,6 +135,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -151,6 +165,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -176,6 +195,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/dataprotection/SubjectErasureByPspReferenceRequest.java b/src/main/java/com/adyen/model/dataprotection/SubjectErasureByPspReferenceRequest.java index 26fc55b66..20f48f5f3 100644 --- a/src/main/java/com/adyen/model/dataprotection/SubjectErasureByPspReferenceRequest.java +++ b/src/main/java/com/adyen/model/dataprotection/SubjectErasureByPspReferenceRequest.java @@ -1,6 +1,5 @@ /* * Adyen Data Protection API - * Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication Each request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Data Protection Service API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure ``` * * The version of the OpenAPI document: 1 * @@ -68,6 +67,11 @@ public Boolean getForceErasure() { } + /** + * Set this to **true** if you want to delete shopper-related data, even if the shopper has an existing recurring transaction. This only deletes the shopper-related data for the specific payment, but does not cancel the existing recurring transaction. + * + * @param forceErasure + */ @JsonProperty(JSON_PROPERTY_FORCE_ERASURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setForceErasure(Boolean forceErasure) { @@ -93,6 +97,11 @@ public String getMerchantAccount() { } + /** + * Your merchant account + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -118,6 +127,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. We will delete all shopper-related data for this payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { diff --git a/src/main/java/com/adyen/model/dataprotection/SubjectErasureResponse.java b/src/main/java/com/adyen/model/dataprotection/SubjectErasureResponse.java index 0d8fe742e..bc56d0b2b 100644 --- a/src/main/java/com/adyen/model/dataprotection/SubjectErasureResponse.java +++ b/src/main/java/com/adyen/model/dataprotection/SubjectErasureResponse.java @@ -1,6 +1,5 @@ /* * Adyen Data Protection API - * Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication Each request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Data Protection Service API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure ``` * * The version of the OpenAPI document: 1 * @@ -99,6 +98,11 @@ public ResultEnum getResult() { } + /** + * The result of this operation. + * + * @param result + */ @JsonProperty(JSON_PROPERTY_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResult(ResultEnum result) { diff --git a/src/main/java/com/adyen/model/disputes/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/disputes/AbstractOpenApiSchema.java index c654050e9..5c96a7bd9 100644 --- a/src/main/java/com/adyen/model/disputes/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/disputes/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * diff --git a/src/main/java/com/adyen/model/disputes/AcceptDisputeRequest.java b/src/main/java/com/adyen/model/disputes/AcceptDisputeRequest.java index 28c99c97f..ca22ae3de 100644 --- a/src/main/java/com/adyen/model/disputes/AcceptDisputeRequest.java +++ b/src/main/java/com/adyen/model/disputes/AcceptDisputeRequest.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -64,6 +63,11 @@ public String getDisputePspReference() { } + /** + * The PSP reference assigned to the dispute. + * + * @param disputePspReference + */ @JsonProperty(JSON_PROPERTY_DISPUTE_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputePspReference(String disputePspReference) { @@ -89,6 +93,11 @@ public String getMerchantAccountCode() { } + /** + * The merchant account identifier, for which you want to process the dispute transaction. + * + * @param merchantAccountCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccountCode(String merchantAccountCode) { diff --git a/src/main/java/com/adyen/model/disputes/AcceptDisputeResponse.java b/src/main/java/com/adyen/model/disputes/AcceptDisputeResponse.java index ba3c8bfa4..76ec34b08 100644 --- a/src/main/java/com/adyen/model/disputes/AcceptDisputeResponse.java +++ b/src/main/java/com/adyen/model/disputes/AcceptDisputeResponse.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -61,6 +60,11 @@ public DisputeServiceResult getDisputeServiceResult() { } + /** + * disputeServiceResult + * + * @param disputeServiceResult + */ @JsonProperty(JSON_PROPERTY_DISPUTE_SERVICE_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputeServiceResult(DisputeServiceResult disputeServiceResult) { diff --git a/src/main/java/com/adyen/model/disputes/DefendDisputeRequest.java b/src/main/java/com/adyen/model/disputes/DefendDisputeRequest.java index 07b62bdc0..d0a1cd9b5 100644 --- a/src/main/java/com/adyen/model/disputes/DefendDisputeRequest.java +++ b/src/main/java/com/adyen/model/disputes/DefendDisputeRequest.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -68,6 +67,11 @@ public String getDefenseReasonCode() { } + /** + * The defense reason code that was selected to defend this dispute. + * + * @param defenseReasonCode + */ @JsonProperty(JSON_PROPERTY_DEFENSE_REASON_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseReasonCode(String defenseReasonCode) { @@ -93,6 +97,11 @@ public String getDisputePspReference() { } + /** + * The PSP reference assigned to the dispute. + * + * @param disputePspReference + */ @JsonProperty(JSON_PROPERTY_DISPUTE_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputePspReference(String disputePspReference) { @@ -118,6 +127,11 @@ public String getMerchantAccountCode() { } + /** + * The merchant account identifier, for which you want to process the dispute transaction. + * + * @param merchantAccountCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccountCode(String merchantAccountCode) { diff --git a/src/main/java/com/adyen/model/disputes/DefendDisputeResponse.java b/src/main/java/com/adyen/model/disputes/DefendDisputeResponse.java index 583624c3d..a1bdd28b5 100644 --- a/src/main/java/com/adyen/model/disputes/DefendDisputeResponse.java +++ b/src/main/java/com/adyen/model/disputes/DefendDisputeResponse.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -61,6 +60,11 @@ public DisputeServiceResult getDisputeServiceResult() { } + /** + * disputeServiceResult + * + * @param disputeServiceResult + */ @JsonProperty(JSON_PROPERTY_DISPUTE_SERVICE_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputeServiceResult(DisputeServiceResult disputeServiceResult) { diff --git a/src/main/java/com/adyen/model/disputes/DefenseDocument.java b/src/main/java/com/adyen/model/disputes/DefenseDocument.java index d05ae5b4f..a5b47f465 100644 --- a/src/main/java/com/adyen/model/disputes/DefenseDocument.java +++ b/src/main/java/com/adyen/model/disputes/DefenseDocument.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -68,6 +67,11 @@ public byte[] getContent() { } + /** + * The content of the defense document. + * + * @param content + */ @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContent(byte[] content) { @@ -93,6 +97,11 @@ public String getContentType() { } + /** + * The content type of the defense document. + * + * @param contentType + */ @JsonProperty(JSON_PROPERTY_CONTENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContentType(String contentType) { @@ -118,6 +127,11 @@ public String getDefenseDocumentTypeCode() { } + /** + * The document type code of the defense document. + * + * @param defenseDocumentTypeCode + */ @JsonProperty(JSON_PROPERTY_DEFENSE_DOCUMENT_TYPE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseDocumentTypeCode(String defenseDocumentTypeCode) { diff --git a/src/main/java/com/adyen/model/disputes/DefenseDocumentType.java b/src/main/java/com/adyen/model/disputes/DefenseDocumentType.java index 5f9cf9759..02c9f6cc3 100644 --- a/src/main/java/com/adyen/model/disputes/DefenseDocumentType.java +++ b/src/main/java/com/adyen/model/disputes/DefenseDocumentType.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -68,6 +67,11 @@ public Boolean getAvailable() { } + /** + * When **true**, you've successfully uploaded this type of defense document. When **false**, you haven't uploaded this defense document type. + * + * @param available + */ @JsonProperty(JSON_PROPERTY_AVAILABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvailable(Boolean available) { @@ -93,6 +97,11 @@ public String getDefenseDocumentTypeCode() { } + /** + * The document type code of the defense document. + * + * @param defenseDocumentTypeCode + */ @JsonProperty(JSON_PROPERTY_DEFENSE_DOCUMENT_TYPE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseDocumentTypeCode(String defenseDocumentTypeCode) { @@ -118,6 +127,11 @@ public String getRequirementLevel() { } + /** + * Indicates to what extent the defense document is required in the defense process. Possible values: * **Required**: You must supply the document. * **OneOrMore**: You must supply at least one of the documents with this label. * **Optional**: You can choose to supply the document. * **AlternativeRequired**: You must supply a generic defense document. To enable this functionality, contact our Support Team. When enabled, you can supply a generic defense document for all schemes. + * + * @param requirementLevel + */ @JsonProperty(JSON_PROPERTY_REQUIREMENT_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequirementLevel(String requirementLevel) { diff --git a/src/main/java/com/adyen/model/disputes/DefenseReason.java b/src/main/java/com/adyen/model/disputes/DefenseReason.java index 171967e69..2d67f4bad 100644 --- a/src/main/java/com/adyen/model/disputes/DefenseReason.java +++ b/src/main/java/com/adyen/model/disputes/DefenseReason.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -79,6 +78,11 @@ public List getDefenseDocumentTypes() { } + /** + * Array of defense document types for a specific defense reason. Indicates the document types that you can submit to the schemes to defend this dispute, and whether they are required. + * + * @param defenseDocumentTypes + */ @JsonProperty(JSON_PROPERTY_DEFENSE_DOCUMENT_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseDocumentTypes(List defenseDocumentTypes) { @@ -104,6 +108,11 @@ public String getDefenseReasonCode() { } + /** + * The defense reason code that was selected to defend this dispute. + * + * @param defenseReasonCode + */ @JsonProperty(JSON_PROPERTY_DEFENSE_REASON_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseReasonCode(String defenseReasonCode) { @@ -129,6 +138,11 @@ public Boolean getSatisfied() { } + /** + * Indicates if sufficient defense material has been supplied. + * + * @param satisfied + */ @JsonProperty(JSON_PROPERTY_SATISFIED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSatisfied(Boolean satisfied) { diff --git a/src/main/java/com/adyen/model/disputes/DefenseReasonsRequest.java b/src/main/java/com/adyen/model/disputes/DefenseReasonsRequest.java index 475cd28be..7eb2cc808 100644 --- a/src/main/java/com/adyen/model/disputes/DefenseReasonsRequest.java +++ b/src/main/java/com/adyen/model/disputes/DefenseReasonsRequest.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -64,6 +63,11 @@ public String getDisputePspReference() { } + /** + * The PSP reference assigned to the dispute. + * + * @param disputePspReference + */ @JsonProperty(JSON_PROPERTY_DISPUTE_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputePspReference(String disputePspReference) { @@ -89,6 +93,11 @@ public String getMerchantAccountCode() { } + /** + * The merchant account identifier, for which you want to process the dispute transaction. + * + * @param merchantAccountCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccountCode(String merchantAccountCode) { diff --git a/src/main/java/com/adyen/model/disputes/DefenseReasonsResponse.java b/src/main/java/com/adyen/model/disputes/DefenseReasonsResponse.java index f0c84d6fd..ec74f3e55 100644 --- a/src/main/java/com/adyen/model/disputes/DefenseReasonsResponse.java +++ b/src/main/java/com/adyen/model/disputes/DefenseReasonsResponse.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -76,6 +75,11 @@ public List getDefenseReasons() { } + /** + * The defense reasons that can be used to defend the dispute. + * + * @param defenseReasons + */ @JsonProperty(JSON_PROPERTY_DEFENSE_REASONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseReasons(List defenseReasons) { @@ -101,6 +105,11 @@ public DisputeServiceResult getDisputeServiceResult() { } + /** + * disputeServiceResult + * + * @param disputeServiceResult + */ @JsonProperty(JSON_PROPERTY_DISPUTE_SERVICE_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputeServiceResult(DisputeServiceResult disputeServiceResult) { diff --git a/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentRequest.java b/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentRequest.java index ee94b0192..90e2a9c83 100644 --- a/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentRequest.java +++ b/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentRequest.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -68,6 +67,11 @@ public String getDefenseDocumentType() { } + /** + * The document type code of the defense document. + * + * @param defenseDocumentType + */ @JsonProperty(JSON_PROPERTY_DEFENSE_DOCUMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseDocumentType(String defenseDocumentType) { @@ -93,6 +97,11 @@ public String getDisputePspReference() { } + /** + * The PSP reference assigned to the dispute. + * + * @param disputePspReference + */ @JsonProperty(JSON_PROPERTY_DISPUTE_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputePspReference(String disputePspReference) { @@ -118,6 +127,11 @@ public String getMerchantAccountCode() { } + /** + * The merchant account identifier, for which you want to process the dispute transaction. + * + * @param merchantAccountCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccountCode(String merchantAccountCode) { diff --git a/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentResponse.java b/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentResponse.java index f461c49ce..1c3072019 100644 --- a/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentResponse.java +++ b/src/main/java/com/adyen/model/disputes/DeleteDefenseDocumentResponse.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -61,6 +60,11 @@ public DisputeServiceResult getDisputeServiceResult() { } + /** + * disputeServiceResult + * + * @param disputeServiceResult + */ @JsonProperty(JSON_PROPERTY_DISPUTE_SERVICE_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputeServiceResult(DisputeServiceResult disputeServiceResult) { diff --git a/src/main/java/com/adyen/model/disputes/DisputeServiceResult.java b/src/main/java/com/adyen/model/disputes/DisputeServiceResult.java index 5b865b22d..14cb7f9aa 100644 --- a/src/main/java/com/adyen/model/disputes/DisputeServiceResult.java +++ b/src/main/java/com/adyen/model/disputes/DisputeServiceResult.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -64,6 +63,11 @@ public String getErrorMessage() { } + /** + * The general error message. + * + * @param errorMessage + */ @JsonProperty(JSON_PROPERTY_ERROR_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorMessage(String errorMessage) { @@ -89,6 +93,11 @@ public Boolean getSuccess() { } + /** + * Indicates whether the request succeeded. + * + * @param success + */ @JsonProperty(JSON_PROPERTY_SUCCESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSuccess(Boolean success) { diff --git a/src/main/java/com/adyen/model/disputes/ServiceError.java b/src/main/java/com/adyen/model/disputes/ServiceError.java index 4a6a3b6c0..f92aff037 100644 --- a/src/main/java/com/adyen/model/disputes/ServiceError.java +++ b/src/main/java/com/adyen/model/disputes/ServiceError.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -76,6 +75,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -101,6 +105,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -126,6 +135,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -151,6 +165,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -176,6 +195,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentRequest.java b/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentRequest.java index 4ac36c28e..d6cb30a64 100644 --- a/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentRequest.java +++ b/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentRequest.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -76,6 +75,11 @@ public List getDefenseDocuments() { } + /** + * An array containing a list of the defense documents. + * + * @param defenseDocuments + */ @JsonProperty(JSON_PROPERTY_DEFENSE_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefenseDocuments(List defenseDocuments) { @@ -101,6 +105,11 @@ public String getDisputePspReference() { } + /** + * The PSP reference assigned to the dispute. + * + * @param disputePspReference + */ @JsonProperty(JSON_PROPERTY_DISPUTE_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputePspReference(String disputePspReference) { @@ -126,6 +135,11 @@ public String getMerchantAccountCode() { } + /** + * The merchant account identifier, for which you want to process the dispute transaction. + * + * @param merchantAccountCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccountCode(String merchantAccountCode) { diff --git a/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentResponse.java b/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentResponse.java index f2c0997b6..fabe34481 100644 --- a/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentResponse.java +++ b/src/main/java/com/adyen/model/disputes/SupplyDefenseDocumentResponse.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -61,6 +60,11 @@ public DisputeServiceResult getDisputeServiceResult() { } + /** + * disputeServiceResult + * + * @param disputeServiceResult + */ @JsonProperty(JSON_PROPERTY_DISPUTE_SERVICE_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputeServiceResult(DisputeServiceResult disputeServiceResult) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/AULocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/AULocalAccountIdentification.java index cb519cb93..8d86f09ca 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/AULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/AULocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBsbCode() { } + /** + * The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. + * + * @param bsbCode + */ @JsonProperty(JSON_PROPERTY_BSB_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBsbCode(String bsbCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **auLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceRequest.java b/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceRequest.java index f760649ad..e85ba4836 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceRequest.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceRequest.java @@ -63,6 +63,11 @@ public String getAcceptedBy() { } + /** + * The legal entity ID of the user accepting the Terms of Service. For organizations, this must be the individual legal entity ID of an authorized signatory for the organization. For sole proprietorships, this must be the individual legal entity ID of the owner. + * + * @param acceptedBy + */ @JsonProperty(JSON_PROPERTY_ACCEPTED_BY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptedBy(String acceptedBy) { @@ -88,6 +93,11 @@ public String getIpAddress() { } + /** + * The IP address of the user accepting the Terms of Service. + * + * @param ipAddress + */ @JsonProperty(JSON_PROPERTY_IP_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIpAddress(String ipAddress) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceResponse.java index 0e32f47bd..4cb95a936 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/AcceptTermsOfServiceResponse.java @@ -124,6 +124,11 @@ public String getAcceptedBy() { } + /** + * The unique identifier of the user that accepted the Terms of Service. + * + * @param acceptedBy + */ @JsonProperty(JSON_PROPERTY_ACCEPTED_BY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptedBy(String acceptedBy) { @@ -149,6 +154,11 @@ public String getId() { } + /** + * The unique identifier of the Terms of Service acceptance. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -174,6 +184,11 @@ public String getIpAddress() { } + /** + * The IP address of the user that accepted the Terms of Service. + * + * @param ipAddress + */ @JsonProperty(JSON_PROPERTY_IP_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIpAddress(String ipAddress) { @@ -199,6 +214,11 @@ public String getLanguage() { } + /** + * The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -224,6 +244,11 @@ public String getTermsOfServiceDocumentId() { } + /** + * The unique identifier of the Terms of Service document. + * + * @param termsOfServiceDocumentId + */ @JsonProperty(JSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTermsOfServiceDocumentId(String termsOfServiceDocumentId) { @@ -249,6 +274,11 @@ public TypeEnum getType() { } + /** + * The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/AdditionalBankIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/AdditionalBankIdentification.java index 6ff3b64f3..483457e47 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/AdditionalBankIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/AdditionalBankIdentification.java @@ -98,6 +98,11 @@ public String getCode() { } + /** + * The value of the additional bank identification. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * The type of additional bank identification, depending on the country. Possible values: * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Address.java b/src/main/java/com/adyen/model/legalentitymanagement/Address.java index 078557742..44220315d 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Address.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Required if `stateOrProvince` is provided. If you specify the city, you must also send `postalCode` and `street`. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getPostalCode() { } + /** + * Postal code. Required if `stateOrProvince` and/or `city` is provided. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -154,6 +169,11 @@ public String getStateOrProvince() { } + /** + * The two-letter ISO 3166-2 state or province code. For example, **CA** in the US. If you specify the state or province, you must also send `city`, `postalCode`, and `street`. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -179,6 +199,11 @@ public String getStreet() { } + /** + * The name of the street, and the house or building number. Required if `stateOrProvince` and/or `city` is provided. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { @@ -204,6 +229,11 @@ public String getStreet2() { } + /** + * The apartment, unit, or suite number. + * + * @param street2 + */ @JsonProperty(JSON_PROPERTY_STREET2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet2(String street2) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Amount.java b/src/main/java/com/adyen/model/legalentitymanagement/Amount.java index 0eef5733f..9d6ee7acf 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Amount.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The type of currency. Must be EUR (or EUR equivalent) + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * Total value of amount. Must be >= 0 + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Attachment.java b/src/main/java/com/adyen/model/legalentitymanagement/Attachment.java index 8fb9ff746..ace9d10d9 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Attachment.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Attachment.java @@ -75,6 +75,11 @@ public byte[] getContent() { } + /** + * The document in Base64-encoded string format. + * + * @param content + */ @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContent(byte[] content) { @@ -102,6 +107,11 @@ public String getContentType() { } + /** + * The file format. Possible values: **application/pdf**, **image/jpg**, **image/jpeg**, **image/png**. + * + * @param contentType + */ @Deprecated @JsonProperty(JSON_PROPERTY_CONTENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -130,6 +140,11 @@ public String getFilename() { } + /** + * The name of the file including the file extension. + * + * @param filename + */ @Deprecated @JsonProperty(JSON_PROPERTY_FILENAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -156,6 +171,11 @@ public String getPageName() { } + /** + * The name of the file including the file extension. + * + * @param pageName + */ @JsonProperty(JSON_PROPERTY_PAGE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPageName(String pageName) { @@ -181,6 +201,11 @@ public String getPageType() { } + /** + * Specifies which side of the ID card is uploaded. * When `type` is **driversLicense** or **identityCard**, set this to **front** or **back**. * When omitted, we infer the page number based on the order of attachments. + * + * @param pageType + */ @JsonProperty(JSON_PROPERTY_PAGE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPageType(String pageType) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/BankAccountInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/BankAccountInfo.java index 73e4874d1..5f5a34fc8 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/BankAccountInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/BankAccountInfo.java @@ -76,6 +76,11 @@ public BankAccountInfoAccountIdentification getAccountIdentification() { } + /** + * accountIdentification + * + * @param accountIdentification + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountIdentification(BankAccountInfoAccountIdentification accountIdentification) { @@ -103,6 +108,11 @@ public String getAccountType() { } + /** + * The type of bank account. + * + * @param accountType + */ @Deprecated @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -129,6 +139,11 @@ public String getBankName() { } + /** + * The name of the banking institution where the bank account is held. + * + * @param bankName + */ @JsonProperty(JSON_PROPERTY_BANK_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankName(String bankName) { @@ -154,6 +169,11 @@ public String getCountryCode() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the bank account is registered. For example, **NL**. + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -179,6 +199,11 @@ public Boolean getTrustedSource() { } + /** + * Identifies if the bank account was created through [instant bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding). + * + * @param trustedSource + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedSource(Boolean trustedSource) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/BirthData.java b/src/main/java/com/adyen/model/legalentitymanagement/BirthData.java index 6df4ffe75..5d0ab8e9e 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/BirthData.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/BirthData.java @@ -59,6 +59,11 @@ public String getDateOfBirth() { } + /** + * The individual's date of birth, in YYYY-MM-DD format. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(String dateOfBirth) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLine.java b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLine.java index 52ac4b7f7..68b96cb7a 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLine.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLine.java @@ -175,6 +175,11 @@ public CapabilityEnum getCapability() { } + /** + * The capability for which you are creating the business line. Possible values: **receivePayments**, **receiveFromPlatformPayments**, **issueBankAccount** + * + * @param capability + */ @Deprecated @JsonProperty(JSON_PROPERTY_CAPABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -201,6 +206,11 @@ public String getId() { } + /** + * The unique identifier of the business line. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -214,10 +224,10 @@ public BusinessLine industryCode(String industryCode) { } /** - * A code that represents the industry of the legal entity. For example, **4431A** for computer software stores. + * A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores. * @return industryCode **/ - @ApiModelProperty(required = true, value = "A code that represents the industry of the legal entity. For example, **4431A** for computer software stores.") + @ApiModelProperty(required = true, value = "A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores.") @JsonProperty(JSON_PROPERTY_INDUSTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -226,6 +236,11 @@ public String getIndustryCode() { } + /** + * A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores. + * + * @param industryCode + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryCode(String industryCode) { @@ -251,6 +266,11 @@ public String getLegalEntityId() { } + /** + * Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -284,6 +304,11 @@ public List getProblems() { } + /** + * The verification errors related to capabilities for this supporting entity. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { @@ -317,6 +342,11 @@ public List getSalesChannels() { } + /** + * A list of channels where goods or services are sold. Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**. Required only in combination with the `service` **paymentProcessing**. + * + * @param salesChannels + */ @JsonProperty(JSON_PROPERTY_SALES_CHANNELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSalesChannels(List salesChannels) { @@ -342,6 +372,11 @@ public ServiceEnum getService() { } + /** + * The service for which you are creating the business line. Possible values: * **paymentProcessing** * **banking** + * + * @param service + */ @JsonProperty(JSON_PROPERTY_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setService(ServiceEnum service) { @@ -367,6 +402,11 @@ public SourceOfFunds getSourceOfFunds() { } + /** + * sourceOfFunds + * + * @param sourceOfFunds + */ @JsonProperty(JSON_PROPERTY_SOURCE_OF_FUNDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSourceOfFunds(SourceOfFunds sourceOfFunds) { @@ -400,6 +440,11 @@ public List getWebData() { } + /** + * List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the `webDataExemption` object. + * + * @param webData + */ @JsonProperty(JSON_PROPERTY_WEB_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebData(List webData) { @@ -425,6 +470,11 @@ public WebDataExemption getWebDataExemption() { } + /** + * webDataExemption + * + * @param webDataExemption + */ @JsonProperty(JSON_PROPERTY_WEB_DATA_EXEMPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebDataExemption(WebDataExemption webDataExemption) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfo.java index a7b08e052..42384296a 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfo.java @@ -166,6 +166,11 @@ public CapabilityEnum getCapability() { } + /** + * The capability for which you are creating the business line. Possible values: **receivePayments**, **receiveFromPlatformPayments**, **issueBankAccount** + * + * @param capability + */ @Deprecated @JsonProperty(JSON_PROPERTY_CAPABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -180,10 +185,10 @@ public BusinessLineInfo industryCode(String industryCode) { } /** - * A code that represents the industry of the legal entity. For example, **4431A** for computer software stores. + * A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores. * @return industryCode **/ - @ApiModelProperty(required = true, value = "A code that represents the industry of the legal entity. For example, **4431A** for computer software stores.") + @ApiModelProperty(required = true, value = "A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores.") @JsonProperty(JSON_PROPERTY_INDUSTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -192,6 +197,11 @@ public String getIndustryCode() { } + /** + * A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores. + * + * @param industryCode + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryCode(String industryCode) { @@ -217,6 +227,11 @@ public String getLegalEntityId() { } + /** + * Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -250,6 +265,11 @@ public List getSalesChannels() { } + /** + * A list of channels where goods or services are sold. Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**. Required only in combination with the `service` **paymentProcessing**. + * + * @param salesChannels + */ @JsonProperty(JSON_PROPERTY_SALES_CHANNELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSalesChannels(List salesChannels) { @@ -275,6 +295,11 @@ public ServiceEnum getService() { } + /** + * The service for which you are creating the business line. Possible values: * **paymentProcessing** * **banking** + * + * @param service + */ @JsonProperty(JSON_PROPERTY_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setService(ServiceEnum service) { @@ -300,6 +325,11 @@ public SourceOfFunds getSourceOfFunds() { } + /** + * sourceOfFunds + * + * @param sourceOfFunds + */ @JsonProperty(JSON_PROPERTY_SOURCE_OF_FUNDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSourceOfFunds(SourceOfFunds sourceOfFunds) { @@ -333,6 +363,11 @@ public List getWebData() { } + /** + * List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the `webDataExemption` object. + * + * @param webData + */ @JsonProperty(JSON_PROPERTY_WEB_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebData(List webData) { @@ -358,6 +393,11 @@ public WebDataExemption getWebDataExemption() { } + /** + * webDataExemption + * + * @param webDataExemption + */ @JsonProperty(JSON_PROPERTY_WEB_DATA_EXEMPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebDataExemption(WebDataExemption webDataExemption) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfoUpdate.java b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfoUpdate.java index 380e5ae1a..9c5534e55 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfoUpdate.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLineInfoUpdate.java @@ -166,6 +166,11 @@ public CapabilityEnum getCapability() { } + /** + * The capability for which you are creating the business line. For example, **receivePayments**. + * + * @param capability + */ @Deprecated @JsonProperty(JSON_PROPERTY_CAPABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -192,6 +197,11 @@ public String getIndustryCode() { } + /** + * A code that represents the industry of your legal entity. For example, **4431A** for computer software stores. + * + * @param industryCode + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryCode(String industryCode) { @@ -217,6 +227,11 @@ public String getLegalEntityId() { } + /** + * Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -250,6 +265,11 @@ public List getSalesChannels() { } + /** + * A list of channels where goods or services are sold. Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**. Required only in combination with the `service` **paymentProcessing**. + * + * @param salesChannels + */ @JsonProperty(JSON_PROPERTY_SALES_CHANNELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSalesChannels(List salesChannels) { @@ -275,6 +295,11 @@ public ServiceEnum getService() { } + /** + * The service for which you are creating the business line. Possible values: * **paymentProcessing** * **banking** + * + * @param service + */ @JsonProperty(JSON_PROPERTY_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setService(ServiceEnum service) { @@ -300,6 +325,11 @@ public SourceOfFunds getSourceOfFunds() { } + /** + * sourceOfFunds + * + * @param sourceOfFunds + */ @JsonProperty(JSON_PROPERTY_SOURCE_OF_FUNDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSourceOfFunds(SourceOfFunds sourceOfFunds) { @@ -333,6 +363,11 @@ public List getWebData() { } + /** + * List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the `webDataExemption` object. + * + * @param webData + */ @JsonProperty(JSON_PROPERTY_WEB_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebData(List webData) { @@ -358,6 +393,11 @@ public WebDataExemption getWebDataExemption() { } + /** + * webDataExemption + * + * @param webDataExemption + */ @JsonProperty(JSON_PROPERTY_WEB_DATA_EXEMPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebDataExemption(WebDataExemption webDataExemption) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLines.java b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLines.java index 442af8ed5..1004df5d4 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/BusinessLines.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/BusinessLines.java @@ -67,6 +67,11 @@ public List getBusinessLines() { } + /** + * List of business lines. + * + * @param businessLines + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLines(List businessLines) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CALocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/CALocalAccountIdentification.java index f761835da..e6bb0dc62 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CALocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CALocalAccountIdentification.java @@ -143,6 +143,11 @@ public String getAccountNumber() { } + /** + * The 5- to 12-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -168,6 +173,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -193,6 +203,11 @@ public String getInstitutionNumber() { } + /** + * The 3-digit institution number, without separators or whitespace. + * + * @param institutionNumber + */ @JsonProperty(JSON_PROPERTY_INSTITUTION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstitutionNumber(String institutionNumber) { @@ -218,6 +233,11 @@ public String getTransitNumber() { } + /** + * The 5-digit transit number, without separators or whitespace. + * + * @param transitNumber + */ @JsonProperty(JSON_PROPERTY_TRANSIT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransitNumber(String transitNumber) { @@ -243,6 +263,11 @@ public TypeEnum getType() { } + /** + * **caLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CZLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/CZLocalAccountIdentification.java index cf42f699f..4574acd37 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CZLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Kód banky), without separators or whitespace. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **czLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CalculateTermsOfServiceStatusResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/CalculateTermsOfServiceStatusResponse.java index 79550d9ba..65bb02776 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CalculateTermsOfServiceStatusResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CalculateTermsOfServiceStatusResponse.java @@ -114,6 +114,11 @@ public List getTermsOfServiceTypes() { } + /** + * The type of Terms of Service that the legal entity needs to accept. If empty, no Terms of Service needs to be accepted. + * + * @param termsOfServiceTypes + */ @JsonProperty(JSON_PROPERTY_TERMS_OF_SERVICE_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTermsOfServiceTypes(List termsOfServiceTypes) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblem.java b/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblem.java index 898b0a17a..1f80c340c 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblem.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblem.java @@ -67,6 +67,11 @@ public CapabilityProblemEntity getEntity() { } + /** + * entity + * + * @param entity + */ @JsonProperty(JSON_PROPERTY_ENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntity(CapabilityProblemEntity entity) { @@ -100,6 +105,11 @@ public List getVerificationErrors() { } + /** + * verificationErrors + * + * @param verificationErrors + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationErrors(List verificationErrors) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntity.java b/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntity.java index e1fcaf6dd..bc645de84 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntity.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntity.java @@ -121,6 +121,11 @@ public List getDocuments() { } + /** + * List of document IDs corresponding to the verification errors from capabilities. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -146,6 +151,11 @@ public String getId() { } + /** + * id + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -171,6 +181,11 @@ public CapabilityProblemEntityRecursive getOwner() { } + /** + * owner + * + * @param owner + */ @JsonProperty(JSON_PROPERTY_OWNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwner(CapabilityProblemEntityRecursive owner) { @@ -196,6 +211,11 @@ public TypeEnum getType() { } + /** + * type + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntityRecursive.java b/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntityRecursive.java index 97ef22821..5ad250998 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntityRecursive.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CapabilityProblemEntityRecursive.java @@ -117,6 +117,11 @@ public List getDocuments() { } + /** + * List of document IDs corresponding to the verification errors from capabilities. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -142,6 +147,11 @@ public String getId() { } + /** + * id + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -167,6 +177,11 @@ public TypeEnum getType() { } + /** + * type + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/CapabilitySettings.java b/src/main/java/com/adyen/model/legalentitymanagement/CapabilitySettings.java index 0b9ec4e8f..09af5df75 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/CapabilitySettings.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/CapabilitySettings.java @@ -162,6 +162,11 @@ public Map getAmountPerIndustry() { } + /** + * The maximum amount a card holder can spend per industry. + * + * @param amountPerIndustry + */ @JsonProperty(JSON_PROPERTY_AMOUNT_PER_INDUSTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountPerIndustry(Map amountPerIndustry) { @@ -187,6 +192,11 @@ public Boolean getAuthorizedCardUsers() { } + /** + * The number of card holders who can use the card. + * + * @param authorizedCardUsers + */ @JsonProperty(JSON_PROPERTY_AUTHORIZED_CARD_USERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorizedCardUsers(Boolean authorizedCardUsers) { @@ -220,6 +230,11 @@ public List getFundingSource() { } + /** + * The funding source of the card, for example **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(List fundingSource) { @@ -245,6 +260,11 @@ public IntervalEnum getInterval() { } + /** + * The period when the rule conditions apply. + * + * @param interval + */ @JsonProperty(JSON_PROPERTY_INTERVAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterval(IntervalEnum interval) { @@ -270,6 +290,11 @@ public Amount getMaxAmount() { } + /** + * maxAmount + * + * @param maxAmount + */ @JsonProperty(JSON_PROPERTY_MAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxAmount(Amount maxAmount) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/DKLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/DKLocalAccountIdentification.java index 93e8921b0..08675916d 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/DKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/DKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Registreringsnummer) (without separators or whitespace). + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **dkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/DataReviewConfirmationResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/DataReviewConfirmationResponse.java index 72fc66b1c..c9d905a94 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/DataReviewConfirmationResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/DataReviewConfirmationResponse.java @@ -59,6 +59,11 @@ public String getDataReviewedAt() { } + /** + * Date when data review was confirmed. + * + * @param dataReviewedAt + */ @JsonProperty(JSON_PROPERTY_DATA_REVIEWED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDataReviewedAt(String dataReviewedAt) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Document.java b/src/main/java/com/adyen/model/legalentitymanagement/Document.java index 159ad6e64..90952b6a3 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Document.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Document.java @@ -171,6 +171,11 @@ public Attachment getAttachment() { } + /** + * attachment + * + * @param attachment + */ @JsonProperty(JSON_PROPERTY_ATTACHMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAttachment(Attachment attachment) { @@ -204,6 +209,11 @@ public List getAttachments() { } + /** + * Array that contains the document. The array supports multiple attachments for uploading different sides or pages of a document. + * + * @param attachments + */ @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAttachments(List attachments) { @@ -229,6 +239,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The creation date of the document. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -254,6 +269,11 @@ public String getDescription() { } + /** + * Your description for the document. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -281,6 +301,11 @@ public String getExpiryDate() { } + /** + * The expiry date of the document, in YYYY-MM-DD format. + * + * @param expiryDate + */ @Deprecated @JsonProperty(JSON_PROPERTY_EXPIRY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -307,6 +332,11 @@ public String getFileName() { } + /** + * The filename of the document. + * + * @param fileName + */ @JsonProperty(JSON_PROPERTY_FILE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFileName(String fileName) { @@ -332,6 +362,11 @@ public String getId() { } + /** + * The unique identifier of the document. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -359,6 +394,11 @@ public String getIssuerCountry() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**. + * + * @param issuerCountry + */ @Deprecated @JsonProperty(JSON_PROPERTY_ISSUER_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -387,6 +427,11 @@ public String getIssuerState() { } + /** + * The state or province where the document was issued (AU only). + * + * @param issuerState + */ @Deprecated @JsonProperty(JSON_PROPERTY_ISSUER_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -413,6 +458,11 @@ public OffsetDateTime getModificationDate() { } + /** + * The modification date of the document. + * + * @param modificationDate + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationDate(OffsetDateTime modificationDate) { @@ -438,6 +488,11 @@ public String getNumber() { } + /** + * The number in the document. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -463,6 +518,11 @@ public OwnerEntity getOwner() { } + /** + * owner + * + * @param owner + */ @JsonProperty(JSON_PROPERTY_OWNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwner(OwnerEntity owner) { @@ -488,6 +548,11 @@ public TypeEnum getType() { } + /** + * Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type. * For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, or **proofOfFundingOrWealthSource**. * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/DocumentPage.java b/src/main/java/com/adyen/model/legalentitymanagement/DocumentPage.java index 440a25362..8ac31b1a2 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/DocumentPage.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/DocumentPage.java @@ -104,6 +104,11 @@ public String getPageName() { } + /** + * pageName + * + * @param pageName + */ @JsonProperty(JSON_PROPERTY_PAGE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPageName(String pageName) { @@ -129,6 +134,11 @@ public Integer getPageNumber() { } + /** + * pageNumber + * + * @param pageNumber + */ @JsonProperty(JSON_PROPERTY_PAGE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPageNumber(Integer pageNumber) { @@ -154,6 +164,11 @@ public TypeEnum getType() { } + /** + * type + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/DocumentReference.java b/src/main/java/com/adyen/model/legalentitymanagement/DocumentReference.java index 5602bbbd9..0951cd046 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/DocumentReference.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/DocumentReference.java @@ -87,6 +87,11 @@ public Boolean getActive() { } + /** + * Identifies whether the document is active and used for checks. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -112,6 +117,11 @@ public String getDescription() { } + /** + * Your description for the document. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -137,6 +147,11 @@ public String getFileName() { } + /** + * Document name. + * + * @param fileName + */ @JsonProperty(JSON_PROPERTY_FILE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFileName(String fileName) { @@ -162,6 +177,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -187,6 +207,11 @@ public OffsetDateTime getModificationDate() { } + /** + * The modification date of the document. + * + * @param modificationDate + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationDate(OffsetDateTime modificationDate) { @@ -220,6 +245,11 @@ public List getPages() { } + /** + * List of document pages + * + * @param pages + */ @JsonProperty(JSON_PROPERTY_PAGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPages(List pages) { @@ -245,6 +275,11 @@ public String getType() { } + /** + * Type of document, used when providing an ID number or uploading a document. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/EntityReference.java b/src/main/java/com/adyen/model/legalentitymanagement/EntityReference.java index 23adfc329..21a44ec80 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/EntityReference.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/EntityReference.java @@ -59,6 +59,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionRequest.java b/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionRequest.java index 181961ddc..4f4053aa7 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionRequest.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionRequest.java @@ -112,6 +112,11 @@ public List getAdditionalSalesChannels() { } + /** + * An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/create-stores/) and [add payment methods](https://docs.adyen.com/marketplaces-and-platforms/payment-methods/) before you generate the questionnaires. Possible values: * **eCommerce** * **pos** * **ecomMoto** * **posMoto** + * + * @param additionalSalesChannels + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_SALES_CHANNELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalSalesChannels(List additionalSalesChannels) { @@ -137,6 +142,11 @@ public String getLanguage() { } + /** + * Sets the language of the PCI questionnaire. Its value is a two-character [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) language code, for example, **en**. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionResponse.java index 0684b7516..b1b0a7c98 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GeneratePciDescriptionResponse.java @@ -69,6 +69,11 @@ public byte[] getContent() { } + /** + * The generated questionnaires in a base64 encoded format. + * + * @param content + */ @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContent(byte[] content) { @@ -94,6 +99,11 @@ public String getLanguage() { } + /** + * The two-letter [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code for the questionnaire. For example, **en**. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -127,6 +137,11 @@ public List getPciTemplateReferences() { } + /** + * The array of Adyen-generated unique identifiers for the questionnaires. + * + * @param pciTemplateReferences + */ @JsonProperty(JSON_PROPERTY_PCI_TEMPLATE_REFERENCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPciTemplateReferences(List pciTemplateReferences) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireInfosResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireInfosResponse.java index 64f990836..2c3593e4c 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireInfosResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireInfosResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * Information about the signed PCI questionnaires. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireResponse.java index 551c91680..c67c8630e 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GetPciQuestionnaireResponse.java @@ -72,6 +72,11 @@ public byte[] getContent() { } + /** + * The generated questionnaire in a base64 encoded format. + * + * @param content + */ @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContent(byte[] content) { @@ -97,6 +102,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * The date the questionnaire was created, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00 + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -122,6 +132,11 @@ public String getId() { } + /** + * The unique identifier of the signed questionnaire. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -147,6 +162,11 @@ public OffsetDateTime getValidUntil() { } + /** + * The expiration date of the questionnaire, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00 + * + * @param validUntil + */ @JsonProperty(JSON_PROPERTY_VALID_UNTIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidUntil(OffsetDateTime validUntil) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceAcceptanceInfosResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceAcceptanceInfosResponse.java index 4c99428d4..10b96d3ce 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceAcceptanceInfosResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceAcceptanceInfosResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * The Terms of Service acceptance information. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentRequest.java b/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentRequest.java index 004a83e65..99d66e6a6 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentRequest.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentRequest.java @@ -108,6 +108,11 @@ public String getLanguage() { } + /** + * The language to be used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -133,6 +138,11 @@ public TypeEnum getType() { } + /** + * The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentResponse.java index 584a5e50f..aaa7d37c4 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/GetTermsOfServiceDocumentResponse.java @@ -120,6 +120,11 @@ public byte[] getDocument() { } + /** + * The Terms of Service document in Base64-encoded format. + * + * @param document + */ @JsonProperty(JSON_PROPERTY_DOCUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocument(byte[] document) { @@ -145,6 +150,11 @@ public String getId() { } + /** + * The unique identifier of the legal entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -170,6 +180,11 @@ public String getLanguage() { } + /** + * The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -195,6 +210,11 @@ public String getTermsOfServiceDocumentId() { } + /** + * The unique identifier of the Terms of Service document. + * + * @param termsOfServiceDocumentId + */ @JsonProperty(JSON_PROPERTY_TERMS_OF_SERVICE_DOCUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTermsOfServiceDocumentId(String termsOfServiceDocumentId) { @@ -220,6 +240,11 @@ public TypeEnum getType() { } + /** + * The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/HKLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/HKLocalAccountIdentification.java index 4cd3a811a..f0f9032f7 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/HKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/HKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingCode() { } + /** + * The 3-digit clearing code, without separators or whitespace. + * + * @param clearingCode + */ @JsonProperty(JSON_PROPERTY_CLEARING_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingCode(String clearingCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **hkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/HULocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/HULocalAccountIdentification.java index 2a047655b..b8aa8d892 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/HULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/HULocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 24-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **huLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/IbanAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/IbanAccountIdentification.java index 1c2e4a17b..3317a16f0 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/IbanAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/IbanAccountIdentification.java @@ -96,6 +96,11 @@ public String getIban() { } + /** + * The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **iban** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/IdentificationData.java b/src/main/java/com/adyen/model/legalentitymanagement/IdentificationData.java index 437b56195..a7c7ff366 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/IdentificationData.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/IdentificationData.java @@ -116,6 +116,11 @@ public String getCardNumber() { } + /** + * The card number of the document that was issued (AU only). + * + * @param cardNumber + */ @JsonProperty(JSON_PROPERTY_CARD_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardNumber(String cardNumber) { @@ -141,6 +146,11 @@ public String getExpiryDate() { } + /** + * The expiry date of the document, in YYYY-MM-DD format. + * + * @param expiryDate + */ @JsonProperty(JSON_PROPERTY_EXPIRY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryDate(String expiryDate) { @@ -168,6 +178,11 @@ public String getIssuerCountry() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code where the document was issued. For example, **US**. + * + * @param issuerCountry + */ @Deprecated @JsonProperty(JSON_PROPERTY_ISSUER_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -194,6 +209,11 @@ public String getIssuerState() { } + /** + * The state or province where the document was issued (AU only). + * + * @param issuerState + */ @JsonProperty(JSON_PROPERTY_ISSUER_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerState(String issuerState) { @@ -219,6 +239,11 @@ public Boolean getNationalIdExempt() { } + /** + * Applies only to individuals in the US. Set to **true** if the individual does not have an SSN. To verify their identity, Adyen will require them to upload an ID document. + * + * @param nationalIdExempt + */ @JsonProperty(JSON_PROPERTY_NATIONAL_ID_EXEMPT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationalIdExempt(Boolean nationalIdExempt) { @@ -244,6 +269,11 @@ public String getNumber() { } + /** + * The number in the document. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -269,6 +299,11 @@ public TypeEnum getType() { } + /** + * Type of identity data. For **individual**, the `type` value is **nationalIdNumber**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Individual.java b/src/main/java/com/adyen/model/legalentitymanagement/Individual.java index d4e5c18d9..2456987f7 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Individual.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Individual.java @@ -100,6 +100,11 @@ public BirthData getBirthData() { } + /** + * birthData + * + * @param birthData + */ @JsonProperty(JSON_PROPERTY_BIRTH_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBirthData(BirthData birthData) { @@ -125,6 +130,11 @@ public String getEmail() { } + /** + * The email address of the legal entity. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -150,6 +160,11 @@ public IdentificationData getIdentificationData() { } + /** + * identificationData + * + * @param identificationData + */ @JsonProperty(JSON_PROPERTY_IDENTIFICATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentificationData(IdentificationData identificationData) { @@ -175,6 +190,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -200,6 +220,11 @@ public String getNationality() { } + /** + * The individual's nationality. + * + * @param nationality + */ @JsonProperty(JSON_PROPERTY_NATIONALITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationality(String nationality) { @@ -225,6 +250,11 @@ public PhoneNumber getPhone() { } + /** + * phone + * + * @param phone + */ @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhone(PhoneNumber phone) { @@ -250,6 +280,11 @@ public Address getResidentialAddress() { } + /** + * residentialAddress + * + * @param residentialAddress + */ @JsonProperty(JSON_PROPERTY_RESIDENTIAL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResidentialAddress(Address residentialAddress) { @@ -283,6 +318,11 @@ public List getTaxInformation() { } + /** + * The tax information of the individual. + * + * @param taxInformation + */ @JsonProperty(JSON_PROPERTY_TAX_INFORMATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxInformation(List taxInformation) { @@ -308,6 +348,11 @@ public WebData getWebData() { } + /** + * webData + * + * @param webData + */ @JsonProperty(JSON_PROPERTY_WEB_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebData(WebData webData) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntity.java b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntity.java index 9311f0f38..0d6422870 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntity.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntity.java @@ -61,7 +61,8 @@ LegalEntity.JSON_PROPERTY_TRUST, LegalEntity.JSON_PROPERTY_TYPE, LegalEntity.JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP, - LegalEntity.JSON_PROPERTY_VERIFICATION_DEADLINES + LegalEntity.JSON_PROPERTY_VERIFICATION_DEADLINES, + LegalEntity.JSON_PROPERTY_VERIFICATION_PLAN }) public class LegalEntity { @@ -151,6 +152,9 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_VERIFICATION_DEADLINES = "verificationDeadlines"; private List verificationDeadlines = null; + public static final String JSON_PROPERTY_VERIFICATION_PLAN = "verificationPlan"; + private String verificationPlan; + public LegalEntity() { } @@ -180,6 +184,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -213,6 +222,11 @@ public List getDocumentDetails() { } + /** + * List of documents uploaded for the legal entity. + * + * @param documentDetails + */ @JsonProperty(JSON_PROPERTY_DOCUMENT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocumentDetails(List documentDetails) { @@ -248,6 +262,11 @@ public List getDocuments() { } + /** + * List of documents uploaded for the legal entity. + * + * @param documents + */ @Deprecated @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -282,6 +301,11 @@ public List getEntityAssociations() { } + /** + * List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories. + * + * @param entityAssociations + */ @JsonProperty(JSON_PROPERTY_ENTITY_ASSOCIATIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityAssociations(List entityAssociations) { @@ -307,6 +331,11 @@ public String getId() { } + /** + * The unique identifier of the legal entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -332,6 +361,11 @@ public Individual getIndividual() { } + /** + * individual + * + * @param individual + */ @JsonProperty(JSON_PROPERTY_INDIVIDUAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndividual(Individual individual) { @@ -357,6 +391,11 @@ public Organization getOrganization() { } + /** + * organization + * + * @param organization + */ @JsonProperty(JSON_PROPERTY_ORGANIZATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrganization(Organization organization) { @@ -390,6 +429,11 @@ public List getProblems() { } + /** + * List of verification errors related to capabilities for the legal entity. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { @@ -415,6 +459,11 @@ public String getReference() { } + /** + * Your reference for the legal entity, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -440,6 +489,11 @@ public SoleProprietorship getSoleProprietorship() { } + /** + * soleProprietorship + * + * @param soleProprietorship + */ @JsonProperty(JSON_PROPERTY_SOLE_PROPRIETORSHIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSoleProprietorship(SoleProprietorship soleProprietorship) { @@ -473,6 +527,11 @@ public List getTransferInstruments() { } + /** + * List of transfer instruments that the legal entity owns. + * + * @param transferInstruments + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstruments(List transferInstruments) { @@ -498,6 +557,11 @@ public Trust getTrust() { } + /** + * trust + * + * @param trust + */ @JsonProperty(JSON_PROPERTY_TRUST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrust(Trust trust) { @@ -523,6 +587,11 @@ public TypeEnum getType() { } + /** + * The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -548,6 +617,11 @@ public UnincorporatedPartnership getUnincorporatedPartnership() { } + /** + * unincorporatedPartnership + * + * @param unincorporatedPartnership + */ @JsonProperty(JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUnincorporatedPartnership(UnincorporatedPartnership unincorporatedPartnership) { @@ -581,6 +655,11 @@ public List getVerificationDeadlines() { } + /** + * List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved. + * + * @param verificationDeadlines + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationDeadlines(List verificationDeadlines) { @@ -588,6 +667,36 @@ public void setVerificationDeadlines(List verificationDead } + public LegalEntity verificationPlan(String verificationPlan) { + this.verificationPlan = verificationPlan; + return this; + } + + /** + * A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). + * @return verificationPlan + **/ + @ApiModelProperty(value = "A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront).") + @JsonProperty(JSON_PROPERTY_VERIFICATION_PLAN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getVerificationPlan() { + return verificationPlan; + } + + + /** + * A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). + * + * @param verificationPlan + */ + @JsonProperty(JSON_PROPERTY_VERIFICATION_PLAN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setVerificationPlan(String verificationPlan) { + this.verificationPlan = verificationPlan; + } + + /** * Return true if this LegalEntity object is equal to o. */ @@ -614,12 +723,13 @@ public boolean equals(Object o) { Objects.equals(this.trust, legalEntity.trust) && Objects.equals(this.type, legalEntity.type) && Objects.equals(this.unincorporatedPartnership, legalEntity.unincorporatedPartnership) && - Objects.equals(this.verificationDeadlines, legalEntity.verificationDeadlines); + Objects.equals(this.verificationDeadlines, legalEntity.verificationDeadlines) && + Objects.equals(this.verificationPlan, legalEntity.verificationPlan); } @Override public int hashCode() { - return Objects.hash(capabilities, documentDetails, documents, entityAssociations, id, individual, organization, problems, reference, soleProprietorship, transferInstruments, trust, type, unincorporatedPartnership, verificationDeadlines); + return Objects.hash(capabilities, documentDetails, documents, entityAssociations, id, individual, organization, problems, reference, soleProprietorship, transferInstruments, trust, type, unincorporatedPartnership, verificationDeadlines, verificationPlan); } @Override @@ -641,6 +751,7 @@ public String toString() { sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" unincorporatedPartnership: ").append(toIndentedString(unincorporatedPartnership)).append("\n"); sb.append(" verificationDeadlines: ").append(toIndentedString(verificationDeadlines)).append("\n"); + sb.append(" verificationPlan: ").append(toIndentedString(verificationPlan)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityAssociation.java b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityAssociation.java index e90af9c58..aec061f73 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityAssociation.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityAssociation.java @@ -144,6 +144,11 @@ public String getAssociatorId() { } + /** + * The unique identifier of another legal entity with which the `legalEntityId` is associated. When the `legalEntityId` is associated to legal entities other than the current one, the response returns all the associations. + * + * @param associatorId + */ @JsonProperty(JSON_PROPERTY_ASSOCIATOR_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatorId(String associatorId) { @@ -169,6 +174,11 @@ public String getEntityType() { } + /** + * The legal entity type of associated legal entity. For example, **organization**, **soleProprietorship** or **individual**. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(String entityType) { @@ -194,6 +204,11 @@ public String getJobTitle() { } + /** + * The individual's job title if the `type` is **uboThroughControl** or **signatory**. + * + * @param jobTitle + */ @JsonProperty(JSON_PROPERTY_JOB_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJobTitle(String jobTitle) { @@ -219,6 +234,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the associated [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id). + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -244,6 +264,11 @@ public String getName() { } + /** + * The name of the associated [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id). - For **individual**, `name.firstName` and `name.lastName`. - For **organization**, `legalName`. - For **soleProprietorship**, `name`. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -277,6 +302,11 @@ public List getSettlorExemptionReason() { } + /** + * Defines the Kyc Exemption Reason for a Settlor associated with a trust. For example, **professionalServiceProvider**, **deceased**, or **contributionBelowThreshold**. + * + * @param settlorExemptionReason + */ @JsonProperty(JSON_PROPERTY_SETTLOR_EXEMPTION_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSettlorExemptionReason(List settlorExemptionReason) { @@ -302,6 +332,11 @@ public TypeEnum getType() { } + /** + * Defines the relationship of the legal entity to the current legal entity. Possible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**. Possible values for sole proprietorships: **soleProprietorship**. Possible value for trusts: **trust** Possible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityCapability.java b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityCapability.java index af7e9251c..9b48e6e2d 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityCapability.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityCapability.java @@ -169,6 +169,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -194,6 +199,11 @@ public AllowedLevelEnum getAllowedLevel() { } + /** + * The capability level that is allowed for the legal entity. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param allowedLevel + */ @JsonProperty(JSON_PROPERTY_ALLOWED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedLevel(AllowedLevelEnum allowedLevel) { @@ -219,6 +229,11 @@ public CapabilitySettings getAllowedSettings() { } + /** + * allowedSettings + * + * @param allowedSettings + */ @JsonProperty(JSON_PROPERTY_ALLOWED_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedSettings(CapabilitySettings allowedSettings) { @@ -244,6 +259,11 @@ public Boolean getRequested() { } + /** + * Indicates whether the capability is requested. To check whether the legal entity is permitted to use the capability, refer to the `allowed` field. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -269,6 +289,11 @@ public RequestedLevelEnum getRequestedLevel() { } + /** + * The requested level of the capability. Some capabilities, such as those used in [card issuing](https://docs.adyen.com/issuing/add-capabilities#capability-levels), have different levels. Levels increase the capability, but also require additional checks and increased monitoring. Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param requestedLevel + */ @JsonProperty(JSON_PROPERTY_REQUESTED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedLevel(RequestedLevelEnum requestedLevel) { @@ -294,6 +319,11 @@ public CapabilitySettings getRequestedSettings() { } + /** + * requestedSettings + * + * @param requestedSettings + */ @JsonProperty(JSON_PROPERTY_REQUESTED_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedSettings(CapabilitySettings requestedSettings) { @@ -327,6 +357,11 @@ public List getTransferInstruments() { } + /** + * The capability status of transfer instruments associated with the legal entity. + * + * @param transferInstruments + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstruments(List transferInstruments) { @@ -352,6 +387,11 @@ public String getVerificationStatus() { } + /** + * The status of the verification checks for the capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(String verificationStatus) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfo.java index 6e5f9b71b..f73da120a 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfo.java @@ -50,7 +50,8 @@ LegalEntityInfo.JSON_PROPERTY_SOLE_PROPRIETORSHIP, LegalEntityInfo.JSON_PROPERTY_TRUST, LegalEntityInfo.JSON_PROPERTY_TYPE, - LegalEntityInfo.JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP + LegalEntityInfo.JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP, + LegalEntityInfo.JSON_PROPERTY_VERIFICATION_PLAN }) public class LegalEntityInfo { @@ -122,6 +123,9 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP = "unincorporatedPartnership"; private UnincorporatedPartnership unincorporatedPartnership; + public static final String JSON_PROPERTY_VERIFICATION_PLAN = "verificationPlan"; + private String verificationPlan; + public LegalEntityInfo() { } @@ -151,6 +155,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -184,6 +193,11 @@ public List getEntityAssociations() { } + /** + * List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories. + * + * @param entityAssociations + */ @JsonProperty(JSON_PROPERTY_ENTITY_ASSOCIATIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityAssociations(List entityAssociations) { @@ -209,6 +223,11 @@ public Individual getIndividual() { } + /** + * individual + * + * @param individual + */ @JsonProperty(JSON_PROPERTY_INDIVIDUAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndividual(Individual individual) { @@ -234,6 +253,11 @@ public Organization getOrganization() { } + /** + * organization + * + * @param organization + */ @JsonProperty(JSON_PROPERTY_ORGANIZATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrganization(Organization organization) { @@ -259,6 +283,11 @@ public String getReference() { } + /** + * Your reference for the legal entity, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -284,6 +313,11 @@ public SoleProprietorship getSoleProprietorship() { } + /** + * soleProprietorship + * + * @param soleProprietorship + */ @JsonProperty(JSON_PROPERTY_SOLE_PROPRIETORSHIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSoleProprietorship(SoleProprietorship soleProprietorship) { @@ -309,6 +343,11 @@ public Trust getTrust() { } + /** + * trust + * + * @param trust + */ @JsonProperty(JSON_PROPERTY_TRUST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrust(Trust trust) { @@ -334,6 +373,11 @@ public TypeEnum getType() { } + /** + * The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -359,6 +403,11 @@ public UnincorporatedPartnership getUnincorporatedPartnership() { } + /** + * unincorporatedPartnership + * + * @param unincorporatedPartnership + */ @JsonProperty(JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUnincorporatedPartnership(UnincorporatedPartnership unincorporatedPartnership) { @@ -366,6 +415,36 @@ public void setUnincorporatedPartnership(UnincorporatedPartnership unincorporate } + public LegalEntityInfo verificationPlan(String verificationPlan) { + this.verificationPlan = verificationPlan; + return this; + } + + /** + * A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). + * @return verificationPlan + **/ + @ApiModelProperty(value = "A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront).") + @JsonProperty(JSON_PROPERTY_VERIFICATION_PLAN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getVerificationPlan() { + return verificationPlan; + } + + + /** + * A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). + * + * @param verificationPlan + */ + @JsonProperty(JSON_PROPERTY_VERIFICATION_PLAN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setVerificationPlan(String verificationPlan) { + this.verificationPlan = verificationPlan; + } + + /** * Return true if this LegalEntityInfo object is equal to o. */ @@ -386,12 +465,13 @@ public boolean equals(Object o) { Objects.equals(this.soleProprietorship, legalEntityInfo.soleProprietorship) && Objects.equals(this.trust, legalEntityInfo.trust) && Objects.equals(this.type, legalEntityInfo.type) && - Objects.equals(this.unincorporatedPartnership, legalEntityInfo.unincorporatedPartnership); + Objects.equals(this.unincorporatedPartnership, legalEntityInfo.unincorporatedPartnership) && + Objects.equals(this.verificationPlan, legalEntityInfo.verificationPlan); } @Override public int hashCode() { - return Objects.hash(capabilities, entityAssociations, individual, organization, reference, soleProprietorship, trust, type, unincorporatedPartnership); + return Objects.hash(capabilities, entityAssociations, individual, organization, reference, soleProprietorship, trust, type, unincorporatedPartnership, verificationPlan); } @Override @@ -407,6 +487,7 @@ public String toString() { sb.append(" trust: ").append(toIndentedString(trust)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" unincorporatedPartnership: ").append(toIndentedString(unincorporatedPartnership)).append("\n"); + sb.append(" verificationPlan: ").append(toIndentedString(verificationPlan)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfoRequiredType.java b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfoRequiredType.java index 5df0acb7b..e6c8ff665 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfoRequiredType.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/LegalEntityInfoRequiredType.java @@ -50,7 +50,8 @@ LegalEntityInfoRequiredType.JSON_PROPERTY_SOLE_PROPRIETORSHIP, LegalEntityInfoRequiredType.JSON_PROPERTY_TRUST, LegalEntityInfoRequiredType.JSON_PROPERTY_TYPE, - LegalEntityInfoRequiredType.JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP + LegalEntityInfoRequiredType.JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP, + LegalEntityInfoRequiredType.JSON_PROPERTY_VERIFICATION_PLAN }) public class LegalEntityInfoRequiredType { @@ -122,6 +123,9 @@ public static TypeEnum fromValue(String value) { public static final String JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP = "unincorporatedPartnership"; private UnincorporatedPartnership unincorporatedPartnership; + public static final String JSON_PROPERTY_VERIFICATION_PLAN = "verificationPlan"; + private String verificationPlan; + public LegalEntityInfoRequiredType() { } @@ -151,6 +155,11 @@ public Map getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that the legal entity can do in your platform.The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -184,6 +193,11 @@ public List getEntityAssociations() { } + /** + * List of legal entities associated with the current legal entity. For example, ultimate beneficial owners associated with an organization through ownership or control, or as signatories. + * + * @param entityAssociations + */ @JsonProperty(JSON_PROPERTY_ENTITY_ASSOCIATIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityAssociations(List entityAssociations) { @@ -209,6 +223,11 @@ public Individual getIndividual() { } + /** + * individual + * + * @param individual + */ @JsonProperty(JSON_PROPERTY_INDIVIDUAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndividual(Individual individual) { @@ -234,6 +253,11 @@ public Organization getOrganization() { } + /** + * organization + * + * @param organization + */ @JsonProperty(JSON_PROPERTY_ORGANIZATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrganization(Organization organization) { @@ -259,6 +283,11 @@ public String getReference() { } + /** + * Your reference for the legal entity, maximum 150 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -284,6 +313,11 @@ public SoleProprietorship getSoleProprietorship() { } + /** + * soleProprietorship + * + * @param soleProprietorship + */ @JsonProperty(JSON_PROPERTY_SOLE_PROPRIETORSHIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSoleProprietorship(SoleProprietorship soleProprietorship) { @@ -309,6 +343,11 @@ public Trust getTrust() { } + /** + * trust + * + * @param trust + */ @JsonProperty(JSON_PROPERTY_TRUST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrust(Trust trust) { @@ -334,6 +373,11 @@ public TypeEnum getType() { } + /** + * The type of legal entity. Possible values: **individual**, **organization**, **soleProprietorship**, or **trust**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -359,6 +403,11 @@ public UnincorporatedPartnership getUnincorporatedPartnership() { } + /** + * unincorporatedPartnership + * + * @param unincorporatedPartnership + */ @JsonProperty(JSON_PROPERTY_UNINCORPORATED_PARTNERSHIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUnincorporatedPartnership(UnincorporatedPartnership unincorporatedPartnership) { @@ -366,6 +415,36 @@ public void setUnincorporatedPartnership(UnincorporatedPartnership unincorporate } + public LegalEntityInfoRequiredType verificationPlan(String verificationPlan) { + this.verificationPlan = verificationPlan; + return this; + } + + /** + * A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). + * @return verificationPlan + **/ + @ApiModelProperty(value = "A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront).") + @JsonProperty(JSON_PROPERTY_VERIFICATION_PLAN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getVerificationPlan() { + return verificationPlan; + } + + + /** + * A key-value pair that specifies the [verification process](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/) for a legal entity. Set to **upfront** for [upfront verification](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details#upfront). + * + * @param verificationPlan + */ + @JsonProperty(JSON_PROPERTY_VERIFICATION_PLAN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setVerificationPlan(String verificationPlan) { + this.verificationPlan = verificationPlan; + } + + /** * Return true if this LegalEntityInfoRequiredType object is equal to o. */ @@ -386,12 +465,13 @@ public boolean equals(Object o) { Objects.equals(this.soleProprietorship, legalEntityInfoRequiredType.soleProprietorship) && Objects.equals(this.trust, legalEntityInfoRequiredType.trust) && Objects.equals(this.type, legalEntityInfoRequiredType.type) && - Objects.equals(this.unincorporatedPartnership, legalEntityInfoRequiredType.unincorporatedPartnership); + Objects.equals(this.unincorporatedPartnership, legalEntityInfoRequiredType.unincorporatedPartnership) && + Objects.equals(this.verificationPlan, legalEntityInfoRequiredType.verificationPlan); } @Override public int hashCode() { - return Objects.hash(capabilities, entityAssociations, individual, organization, reference, soleProprietorship, trust, type, unincorporatedPartnership); + return Objects.hash(capabilities, entityAssociations, individual, organization, reference, soleProprietorship, trust, type, unincorporatedPartnership, verificationPlan); } @Override @@ -407,6 +487,7 @@ public String toString() { sb.append(" trust: ").append(toIndentedString(trust)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" unincorporatedPartnership: ").append(toIndentedString(unincorporatedPartnership)).append("\n"); + sb.append(" verificationPlan: ").append(toIndentedString(verificationPlan)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/adyen/model/legalentitymanagement/NOLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/NOLocalAccountIdentification.java index 9be078839..8a9ada512 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/NOLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/NOLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 11-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **noLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/NZLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/NZLocalAccountIdentification.java index 9677f5cd2..daef9b57d 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/NZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/NZLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **nzLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Name.java b/src/main/java/com/adyen/model/legalentitymanagement/Name.java index 334bad7d0..2a9cdafb2 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Name.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Name.java @@ -67,6 +67,11 @@ public String getFirstName() { } + /** + * The individual's first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -92,6 +97,11 @@ public String getInfix() { } + /** + * The infix in the individual's name, if any. + * + * @param infix + */ @JsonProperty(JSON_PROPERTY_INFIX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInfix(String infix) { @@ -117,6 +127,11 @@ public String getLastName() { } + /** + * The individual's last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/NumberAndBicAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/NumberAndBicAccountIdentification.java index 4c82196b4..cddbc11a2 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/NumberAndBicAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/NumberAndBicAccountIdentification.java @@ -105,6 +105,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. The length and format depends on the bank or country. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -130,6 +135,11 @@ public AdditionalBankIdentification getAdditionalBankIdentification() { } + /** + * additionalBankIdentification + * + * @param additionalBankIdentification + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_BANK_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalBankIdentification(AdditionalBankIdentification additionalBankIdentification) { @@ -155,6 +165,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -180,6 +195,11 @@ public TypeEnum getType() { } + /** + * **numberAndBic** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLink.java b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLink.java index 40ec62f0b..d8c193fdf 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLink.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLink.java @@ -59,6 +59,11 @@ public String getUrl() { } + /** + * The URL of the hosted onboarding page where you need to redirect your user. This URL expires after 4 minutes and can only be used once. If the link expires, you need to create a new link. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLinkInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLinkInfo.java index 8d73bd12e..33f1cd726 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLinkInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingLinkInfo.java @@ -74,6 +74,11 @@ public String getLocale() { } + /** + * The language that will be used for the page, specified by a combination of two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language and [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country codes. See [possible values](https://docs.adyen.com/marketplaces-and-platforms/collect-verification-details/hosted#supported-languages). If not specified in the request or if the language is not supported, the page uses the browser language. If the browser language is not supported, the page uses **en-US** by default. + * + * @param locale + */ @JsonProperty(JSON_PROPERTY_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocale(String locale) { @@ -99,6 +104,11 @@ public String getRedirectUrl() { } + /** + * The URL where the user is redirected after they complete hosted onboarding. + * + * @param redirectUrl + */ @JsonProperty(JSON_PROPERTY_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRedirectUrl(String redirectUrl) { @@ -132,6 +142,11 @@ public Map getSettings() { } + /** + * Boolean key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings. Possible keys: By default, these values are set to **true**. Set to **false** to not allow the action. - **changeLegalEntityType**: The user can change their legal entity type. - **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization. By default, these values are set to **false**. Set to **true** to allow the action. - **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable. - **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country than the country of their legal entity. By default, these value are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels. - **requirePciSignEcommerce** - **requirePciSignPos** - **requirePciSignEcomMoto** - **requirePciSignPosMoto** + * + * @param settings + */ @JsonProperty(JSON_PROPERTY_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSettings(Map settings) { @@ -157,6 +172,11 @@ public String getThemeId() { } + /** + * The unique identifier of the hosted onboarding theme. + * + * @param themeId + */ @JsonProperty(JSON_PROPERTY_THEME_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThemeId(String themeId) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingTheme.java b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingTheme.java index 9cfc1ae8e..c5eed7451 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingTheme.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingTheme.java @@ -79,6 +79,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * The creation date of the theme. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -104,6 +109,11 @@ public String getDescription() { } + /** + * The description of the theme. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -129,6 +139,11 @@ public String getId() { } + /** + * The unique identifier of the theme. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -159,6 +174,11 @@ public Map getProperties() { } + /** + * The properties of the theme. + * + * @param properties + */ @JsonProperty(JSON_PROPERTY_PROPERTIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProperties(Map properties) { @@ -184,6 +204,11 @@ public OffsetDateTime getUpdatedAt() { } + /** + * The date when the theme was last updated. + * + * @param updatedAt + */ @JsonProperty(JSON_PROPERTY_UPDATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpdatedAt(OffsetDateTime updatedAt) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingThemes.java b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingThemes.java index 901a1c3a7..a5252b529 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/OnboardingThemes.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/OnboardingThemes.java @@ -70,6 +70,11 @@ public String getNext() { } + /** + * The next page. Only present if there is a next page. + * + * @param next + */ @JsonProperty(JSON_PROPERTY_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNext(String next) { @@ -95,6 +100,11 @@ public String getPrevious() { } + /** + * The previous page. Only present if there is a previous page. + * + * @param previous + */ @JsonProperty(JSON_PROPERTY_PREVIOUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrevious(String previous) { @@ -125,6 +135,11 @@ public List getThemes() { } + /** + * List of onboarding themes. + * + * @param themes + */ @JsonProperty(JSON_PROPERTY_THEMES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThemes(List themes) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Organization.java b/src/main/java/com/adyen/model/legalentitymanagement/Organization.java index f41f3c2dd..842fc3441 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Organization.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Organization.java @@ -205,6 +205,11 @@ public String getDateOfIncorporation() { } + /** + * The date when the organization was incorporated in YYYY-MM-DD format. + * + * @param dateOfIncorporation + */ @JsonProperty(JSON_PROPERTY_DATE_OF_INCORPORATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfIncorporation(String dateOfIncorporation) { @@ -230,6 +235,11 @@ public String getDescription() { } + /** + * Your description for the organization. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -255,6 +265,11 @@ public String getDoingBusinessAs() { } + /** + * The organization's trading name, if different from the registered legal name. + * + * @param doingBusinessAs + */ @JsonProperty(JSON_PROPERTY_DOING_BUSINESS_AS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDoingBusinessAs(String doingBusinessAs) { @@ -280,6 +295,11 @@ public String getEmail() { } + /** + * The email address of the legal entity. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -305,6 +325,11 @@ public String getLegalName() { } + /** + * The organization's legal name. + * + * @param legalName + */ @JsonProperty(JSON_PROPERTY_LEGAL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalName(String legalName) { @@ -330,6 +355,11 @@ public PhoneNumber getPhone() { } + /** + * phone + * + * @param phone + */ @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhone(PhoneNumber phone) { @@ -355,6 +385,11 @@ public Address getPrincipalPlaceOfBusiness() { } + /** + * principalPlaceOfBusiness + * + * @param principalPlaceOfBusiness + */ @JsonProperty(JSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrincipalPlaceOfBusiness(Address principalPlaceOfBusiness) { @@ -380,6 +415,11 @@ public Address getRegisteredAddress() { } + /** + * registeredAddress + * + * @param registeredAddress + */ @JsonProperty(JSON_PROPERTY_REGISTERED_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegisteredAddress(Address registeredAddress) { @@ -405,6 +445,11 @@ public String getRegistrationNumber() { } + /** + * The organization's registration number. + * + * @param registrationNumber + */ @JsonProperty(JSON_PROPERTY_REGISTRATION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegistrationNumber(String registrationNumber) { @@ -430,6 +475,11 @@ public StockData getStockData() { } + /** + * stockData + * + * @param stockData + */ @JsonProperty(JSON_PROPERTY_STOCK_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStockData(StockData stockData) { @@ -463,6 +513,11 @@ public List getTaxInformation() { } + /** + * The tax information of the organization. + * + * @param taxInformation + */ @JsonProperty(JSON_PROPERTY_TAX_INFORMATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxInformation(List taxInformation) { @@ -488,6 +543,11 @@ public TaxReportingClassification getTaxReportingClassification() { } + /** + * taxReportingClassification + * + * @param taxReportingClassification + */ @JsonProperty(JSON_PROPERTY_TAX_REPORTING_CLASSIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxReportingClassification(TaxReportingClassification taxReportingClassification) { @@ -513,6 +573,11 @@ public TypeEnum getType() { } + /** + * Type of organization. Possible values: **associationIncorporated**, **governmentalOrganization**, **listedPublicCompany**, **nonProfit**, **partnershipIncorporated**, **privateCompany**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -538,6 +603,11 @@ public VatAbsenceReasonEnum getVatAbsenceReason() { } + /** + * The reason the organization has not provided a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**. + * + * @param vatAbsenceReason + */ @JsonProperty(JSON_PROPERTY_VAT_ABSENCE_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatAbsenceReason(VatAbsenceReasonEnum vatAbsenceReason) { @@ -563,6 +633,11 @@ public String getVatNumber() { } + /** + * The organization's VAT number. + * + * @param vatNumber + */ @JsonProperty(JSON_PROPERTY_VAT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatNumber(String vatNumber) { @@ -588,6 +663,11 @@ public WebData getWebData() { } + /** + * webData + * + * @param webData + */ @JsonProperty(JSON_PROPERTY_WEB_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebData(WebData webData) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/OwnerEntity.java b/src/main/java/com/adyen/model/legalentitymanagement/OwnerEntity.java index 9afabc24f..b0304b203 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/OwnerEntity.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/OwnerEntity.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * Unique identifier of the resource that owns the document. For `type` **legalEntity**, this value is the unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id). For `type` **bankAccount**, this value is the unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments#responses-200-id). + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * Type of resource that owns the document. Possible values: **legalEntity**, **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/PLLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/PLLocalAccountIdentification.java index 849be432b..7bb40847e 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/PLLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/PLLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **plLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/PciDocumentInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/PciDocumentInfo.java index aefbf08db..1f66bcd97 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/PciDocumentInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/PciDocumentInfo.java @@ -68,6 +68,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * The date the questionnaire was created, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00 + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -93,6 +98,11 @@ public String getId() { } + /** + * The unique identifier of the signed questionnaire. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -118,6 +128,11 @@ public OffsetDateTime getValidUntil() { } + /** + * The expiration date of the questionnaire, in ISO 8601 extended format. For example, 2022-12-18T10:15:30+01:00 + * + * @param validUntil + */ @JsonProperty(JSON_PROPERTY_VALID_UNTIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidUntil(OffsetDateTime validUntil) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/PciSigningRequest.java b/src/main/java/com/adyen/model/legalentitymanagement/PciSigningRequest.java index e604cb579..1829b148c 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/PciSigningRequest.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/PciSigningRequest.java @@ -70,6 +70,11 @@ public List getPciTemplateReferences() { } + /** + * The array of Adyen-generated unique identifiers for the questionnaires. + * + * @param pciTemplateReferences + */ @JsonProperty(JSON_PROPERTY_PCI_TEMPLATE_REFERENCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPciTemplateReferences(List pciTemplateReferences) { @@ -95,6 +100,11 @@ public String getSignedBy() { } + /** + * The [legal entity ID](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) of the individual who signs the PCI questionnaire. + * + * @param signedBy + */ @JsonProperty(JSON_PROPERTY_SIGNED_BY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignedBy(String signedBy) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/PciSigningResponse.java b/src/main/java/com/adyen/model/legalentitymanagement/PciSigningResponse.java index 80787fc78..6e2d365df 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/PciSigningResponse.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/PciSigningResponse.java @@ -73,6 +73,11 @@ public List getPciQuestionnaireIds() { } + /** + * The unique identifiers of the signed PCI documents. + * + * @param pciQuestionnaireIds + */ @JsonProperty(JSON_PROPERTY_PCI_QUESTIONNAIRE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPciQuestionnaireIds(List pciQuestionnaireIds) { @@ -98,6 +103,11 @@ public String getSignedBy() { } + /** + * The [legal entity ID](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) of the individual who signed the PCI questionnaire. + * + * @param signedBy + */ @JsonProperty(JSON_PROPERTY_SIGNED_BY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignedBy(String signedBy) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/PhoneNumber.java b/src/main/java/com/adyen/model/legalentitymanagement/PhoneNumber.java index e6d7f04ba..d934ba56a 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/PhoneNumber.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/PhoneNumber.java @@ -63,6 +63,11 @@ public String getNumber() { } + /** + * The full phone number, including the country code. For example, **+3112345678**. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * The type of phone number. Possible values: **mobile**, **landline**, **sip**, **fax.** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/RemediatingAction.java b/src/main/java/com/adyen/model/legalentitymanagement/RemediatingAction.java index 27f293282..caf8da4a6 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/RemediatingAction.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/RemediatingAction.java @@ -63,6 +63,11 @@ public String getCode() { } + /** + * code + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -88,6 +93,11 @@ public String getMessage() { } + /** + * message + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/SELocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/SELocalAccountIdentification.java index 64765ad3e..8dd33137c 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/SELocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/SELocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingNumber() { } + /** + * The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. + * + * @param clearingNumber + */ @JsonProperty(JSON_PROPERTY_CLEARING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingNumber(String clearingNumber) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **seLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/SGLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/SGLocalAccountIdentification.java index dfb532aec..057d4df66 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/SGLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/SGLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4- to 19-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **sgLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/ServiceError.java b/src/main/java/com/adyen/model/legalentitymanagement/ServiceError.java index 06f376413..984064eda 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/ServiceError.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/ServiceError.java @@ -75,6 +75,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -100,6 +105,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -125,6 +135,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -150,6 +165,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -175,6 +195,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/SoleProprietorship.java b/src/main/java/com/adyen/model/legalentitymanagement/SoleProprietorship.java index 8ce3d4fe7..28b411aa2 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/SoleProprietorship.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/SoleProprietorship.java @@ -138,6 +138,11 @@ public String getCountryOfGoverningLaw() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country. + * + * @param countryOfGoverningLaw + */ @JsonProperty(JSON_PROPERTY_COUNTRY_OF_GOVERNING_LAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryOfGoverningLaw(String countryOfGoverningLaw) { @@ -163,6 +168,11 @@ public String getDateOfIncorporation() { } + /** + * The date when the legal arrangement was incorporated in YYYY-MM-DD format. + * + * @param dateOfIncorporation + */ @JsonProperty(JSON_PROPERTY_DATE_OF_INCORPORATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfIncorporation(String dateOfIncorporation) { @@ -188,6 +198,11 @@ public String getDescription() { } + /** + * Short description about the Legal Arrangement. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -213,6 +228,11 @@ public String getDoingBusinessAs() { } + /** + * The registered name, if different from the `name`. + * + * @param doingBusinessAs + */ @JsonProperty(JSON_PROPERTY_DOING_BUSINESS_AS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDoingBusinessAs(String doingBusinessAs) { @@ -238,6 +258,11 @@ public String getName() { } + /** + * The legal name. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -263,6 +288,11 @@ public Address getPrincipalPlaceOfBusiness() { } + /** + * principalPlaceOfBusiness + * + * @param principalPlaceOfBusiness + */ @JsonProperty(JSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrincipalPlaceOfBusiness(Address principalPlaceOfBusiness) { @@ -288,6 +318,11 @@ public Address getRegisteredAddress() { } + /** + * registeredAddress + * + * @param registeredAddress + */ @JsonProperty(JSON_PROPERTY_REGISTERED_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegisteredAddress(Address registeredAddress) { @@ -313,6 +348,11 @@ public String getRegistrationNumber() { } + /** + * The registration number. + * + * @param registrationNumber + */ @JsonProperty(JSON_PROPERTY_REGISTRATION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegistrationNumber(String registrationNumber) { @@ -346,6 +386,11 @@ public List getTaxInformation() { } + /** + * The tax information of the entity. + * + * @param taxInformation + */ @JsonProperty(JSON_PROPERTY_TAX_INFORMATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxInformation(List taxInformation) { @@ -371,6 +416,11 @@ public VatAbsenceReasonEnum getVatAbsenceReason() { } + /** + * The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**. + * + * @param vatAbsenceReason + */ @JsonProperty(JSON_PROPERTY_VAT_ABSENCE_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatAbsenceReason(VatAbsenceReasonEnum vatAbsenceReason) { @@ -396,6 +446,11 @@ public String getVatNumber() { } + /** + * The VAT number. + * + * @param vatNumber + */ @JsonProperty(JSON_PROPERTY_VAT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatNumber(String vatNumber) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/SourceOfFunds.java b/src/main/java/com/adyen/model/legalentitymanagement/SourceOfFunds.java index 54022537e..c7f11b0cd 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/SourceOfFunds.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/SourceOfFunds.java @@ -106,6 +106,11 @@ public String getAcquiringBusinessLineId() { } + /** + * The unique identifier of the business line that will be the source of funds.This must be a business line for a **receivePayments** or **receiveFromPlatformPayments** capability. + * + * @param acquiringBusinessLineId + */ @Deprecated @JsonProperty(JSON_PROPERTY_ACQUIRING_BUSINESS_LINE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -132,6 +137,11 @@ public Boolean getAdyenProcessedFunds() { } + /** + * Indicates whether the funds are coming from transactions processed by Adyen. If **false**, a `description` is required. + * + * @param adyenProcessedFunds + */ @JsonProperty(JSON_PROPERTY_ADYEN_PROCESSED_FUNDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenProcessedFunds(Boolean adyenProcessedFunds) { @@ -157,6 +167,11 @@ public String getDescription() { } + /** + * Text describing the source of funds. For example, for `type` **business**, provide a description of where the business transactions come from, such as payments through bank transfer. Required when `adyenProcessedFunds` is **false**. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -182,6 +197,11 @@ public TypeEnum getType() { } + /** + * The type of the source of funds. Possible value: **business**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/StockData.java b/src/main/java/com/adyen/model/legalentitymanagement/StockData.java index 7094a7bac..3f6ea18b3 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/StockData.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/StockData.java @@ -67,6 +67,11 @@ public String getMarketIdentifier() { } + /** + * The four-digit [Market Identifier Code](https://en.wikipedia.org/wiki/Market_Identifier_Code) of the stock market where the organization's stocks are traded. + * + * @param marketIdentifier + */ @JsonProperty(JSON_PROPERTY_MARKET_IDENTIFIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMarketIdentifier(String marketIdentifier) { @@ -92,6 +97,11 @@ public String getStockNumber() { } + /** + * The 12-digit International Securities Identification Number (ISIN) of the company, without dashes (-). + * + * @param stockNumber + */ @JsonProperty(JSON_PROPERTY_STOCK_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStockNumber(String stockNumber) { @@ -117,6 +127,11 @@ public String getTickerSymbol() { } + /** + * The stock ticker symbol. + * + * @param tickerSymbol + */ @JsonProperty(JSON_PROPERTY_TICKER_SYMBOL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTickerSymbol(String tickerSymbol) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/SupportingEntityCapability.java b/src/main/java/com/adyen/model/legalentitymanagement/SupportingEntityCapability.java index f6c42b7b1..21e1d6e19 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/SupportingEntityCapability.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/SupportingEntityCapability.java @@ -71,6 +71,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the capability is allowed for the supporting entity. If a capability is allowed for a supporting entity but not for the parent legal entity, this means the legal entity has other supporting entities that failed verification. **You can use the allowed supporting entity** regardless of the verification status of other supporting entities. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -96,6 +101,11 @@ public String getId() { } + /** + * Supporting entity reference + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -121,6 +131,11 @@ public Boolean getRequested() { } + /** + * Indicates whether the supporting entity capability is requested. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -146,6 +161,11 @@ public String getVerificationStatus() { } + /** + * The status of the verification checks for the capability of the supporting entity. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification has been successfully completed. * **rejected**: Adyen has verified the information, but found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(String verificationStatus) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/TaxInformation.java b/src/main/java/com/adyen/model/legalentitymanagement/TaxInformation.java index a35798ae1..5934f1bef 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/TaxInformation.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/TaxInformation.java @@ -67,6 +67,11 @@ public String getCountry() { } + /** + * The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -92,6 +97,11 @@ public String getNumber() { } + /** + * The tax ID number (TIN) of the organization or individual. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -117,6 +127,11 @@ public String getType() { } + /** + * The TIN type depending on the country where it was issued. Provide only for countries that have multiple tax IDs, such as Sweden, the UK, or the US. For example, provide **SSN**, **EIN**, or **ITIN** for the US. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/TaxReportingClassification.java b/src/main/java/com/adyen/model/legalentitymanagement/TaxReportingClassification.java index 8dad57ed0..2a79ab332 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/TaxReportingClassification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/TaxReportingClassification.java @@ -194,6 +194,11 @@ public BusinessTypeEnum getBusinessType() { } + /** + * The organization's business type. Possible values: **other**, **listedPublicCompany**, **subsidiaryOfListedPublicCompany**, **governmentalOrganization**, **internationalOrganization**, **financialInstitution**. + * + * @param businessType + */ @JsonProperty(JSON_PROPERTY_BUSINESS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessType(BusinessTypeEnum businessType) { @@ -219,6 +224,11 @@ public String getFinancialInstitutionNumber() { } + /** + * The Global Intermediary Identification Number (GIIN) required for FATCA. Only required if the organization is a US financial institution and the `businessType` is **financialInstitution**. + * + * @param financialInstitutionNumber + */ @JsonProperty(JSON_PROPERTY_FINANCIAL_INSTITUTION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFinancialInstitutionNumber(String financialInstitutionNumber) { @@ -244,6 +254,11 @@ public MainSourceOfIncomeEnum getMainSourceOfIncome() { } + /** + * The organization's main source of income. Possible values: **businessOperation**, **realEstateSales**, **investmentInterestOrRoyalty**, **propertyRental**, **other**. + * + * @param mainSourceOfIncome + */ @JsonProperty(JSON_PROPERTY_MAIN_SOURCE_OF_INCOME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMainSourceOfIncome(MainSourceOfIncomeEnum mainSourceOfIncome) { @@ -269,6 +284,11 @@ public TypeEnum getType() { } + /** + * The tax reporting classification type. Possible values: **nonFinancialNonReportable**, **financialNonReportable**, **nonFinancialActive**, **nonFinancialPassive**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/TermsOfServiceAcceptanceInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/TermsOfServiceAcceptanceInfo.java index 427e7ae65..69b22e5da 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/TermsOfServiceAcceptanceInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/TermsOfServiceAcceptanceInfo.java @@ -121,6 +121,11 @@ public String getAcceptedBy() { } + /** + * The unique identifier of the user that accepted the Terms of Service. + * + * @param acceptedBy + */ @JsonProperty(JSON_PROPERTY_ACCEPTED_BY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptedBy(String acceptedBy) { @@ -146,6 +151,11 @@ public String getAcceptedFor() { } + /** + * The unique identifier of the legal entity for which the Terms of Service are accepted. + * + * @param acceptedFor + */ @JsonProperty(JSON_PROPERTY_ACCEPTED_FOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptedFor(String acceptedFor) { @@ -171,6 +181,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * The date when the Terms of Service were accepted. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -196,6 +211,11 @@ public String getId() { } + /** + * An Adyen-generated reference for the accepted Terms of Service. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -221,6 +241,11 @@ public TypeEnum getType() { } + /** + * The type of Terms of Service. Possible values: * **adyenForPlatformsManage** * **adyenIssuing** * **adyenForPlatformsAdvanced** * **adyenCapital** * **adyenAccount** * **adyenCard** * **adyenFranchisee** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrument.java b/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrument.java index b9f6f08b5..468fc7e5e 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrument.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrument.java @@ -126,6 +126,11 @@ public BankAccountInfo getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccountInfo bankAccount) { @@ -159,6 +164,11 @@ public Map getCapabilities() { } + /** + * List of capabilities for this transfer instrument. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -192,6 +202,11 @@ public List getDocumentDetails() { } + /** + * List of documents uploaded for the transfer instrument. + * + * @param documentDetails + */ @JsonProperty(JSON_PROPERTY_DOCUMENT_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocumentDetails(List documentDetails) { @@ -217,6 +232,11 @@ public String getId() { } + /** + * The unique identifier of the transfer instrument. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -242,6 +262,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) that owns the transfer instrument. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -275,6 +300,11 @@ public List getProblems() { } + /** + * The verification errors related to capabilities for this transfer instrument. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { @@ -300,6 +330,11 @@ public TypeEnum getType() { } + /** + * The type of transfer instrument. Possible value: **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentInfo.java b/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentInfo.java index acc49ef01..8445747cc 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentInfo.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentInfo.java @@ -103,6 +103,11 @@ public BankAccountInfo getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccountInfo bankAccount) { @@ -128,6 +133,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id) that owns the transfer instrument. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -153,6 +163,11 @@ public TypeEnum getType() { } + /** + * The type of transfer instrument. Possible value: **bankAccount**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentReference.java b/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentReference.java index 7d7da0bb0..310e68285 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentReference.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/TransferInstrumentReference.java @@ -71,6 +71,11 @@ public String getAccountIdentifier() { } + /** + * The masked IBAN or bank account number. + * + * @param accountIdentifier + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountIdentifier(String accountIdentifier) { @@ -96,6 +101,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -121,6 +131,11 @@ public String getRealLastFour() { } + /** + * Four last digits of the bank account number. If the transfer instrument is created using [instant bank account verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding), and it is a virtual bank account, these digits may be different from the last four digits of the masked account number. + * + * @param realLastFour + */ @JsonProperty(JSON_PROPERTY_REAL_LAST_FOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRealLastFour(String realLastFour) { @@ -146,6 +161,11 @@ public Boolean getTrustedSource() { } + /** + * Identifies if the bank account was created through [instant bank verification](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-08-hosted-onboarding). + * + * @param trustedSource + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedSource(Boolean trustedSource) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/Trust.java b/src/main/java/com/adyen/model/legalentitymanagement/Trust.java index 6cabcc558..ca2ea1370 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/Trust.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/Trust.java @@ -208,6 +208,11 @@ public String getCountryOfGoverningLaw() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country. + * + * @param countryOfGoverningLaw + */ @JsonProperty(JSON_PROPERTY_COUNTRY_OF_GOVERNING_LAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryOfGoverningLaw(String countryOfGoverningLaw) { @@ -233,6 +238,11 @@ public String getDateOfIncorporation() { } + /** + * The date when the legal arrangement was incorporated in YYYY-MM-DD format. + * + * @param dateOfIncorporation + */ @JsonProperty(JSON_PROPERTY_DATE_OF_INCORPORATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfIncorporation(String dateOfIncorporation) { @@ -258,6 +268,11 @@ public String getDescription() { } + /** + * Short description about the trust. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -283,6 +298,11 @@ public String getDoingBusinessAs() { } + /** + * The registered name, if different from the `name`. + * + * @param doingBusinessAs + */ @JsonProperty(JSON_PROPERTY_DOING_BUSINESS_AS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDoingBusinessAs(String doingBusinessAs) { @@ -308,6 +328,11 @@ public String getName() { } + /** + * The legal name. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -333,6 +358,11 @@ public Address getPrincipalPlaceOfBusiness() { } + /** + * principalPlaceOfBusiness + * + * @param principalPlaceOfBusiness + */ @JsonProperty(JSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrincipalPlaceOfBusiness(Address principalPlaceOfBusiness) { @@ -358,6 +388,11 @@ public Address getRegisteredAddress() { } + /** + * registeredAddress + * + * @param registeredAddress + */ @JsonProperty(JSON_PROPERTY_REGISTERED_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegisteredAddress(Address registeredAddress) { @@ -383,6 +418,11 @@ public String getRegistrationNumber() { } + /** + * The registration number. + * + * @param registrationNumber + */ @JsonProperty(JSON_PROPERTY_REGISTRATION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegistrationNumber(String registrationNumber) { @@ -416,6 +456,11 @@ public List getTaxInformation() { } + /** + * The tax information of the entity. + * + * @param taxInformation + */ @JsonProperty(JSON_PROPERTY_TAX_INFORMATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxInformation(List taxInformation) { @@ -441,6 +486,11 @@ public TypeEnum getType() { } + /** + * Type of trust. Possible values for Australian trusts: **cashManagementTrust**, **corporateUnitTrust**, **deceasedEstate**, **discretionaryInvestmentTrust**, **discretionaryServicesManagementTrust**, **discretionaryTradingTrust**, **firstHomeSaverAccountsTrust**, **fixedTrust**, **fixedUnitTrust**, **hybridTrust**, **listedPublicUnitTrust**, **otherTrust**, **pooledSuperannuationTrust**, **publicTradingTrust**, **unlistedPublicUnitTrust**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -474,6 +524,11 @@ public List getUndefinedBeneficiaryInfo() { } + /** + * The undefined beneficiary information of the entity. + * + * @param undefinedBeneficiaryInfo + */ @JsonProperty(JSON_PROPERTY_UNDEFINED_BENEFICIARY_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUndefinedBeneficiaryInfo(List undefinedBeneficiaryInfo) { @@ -499,6 +554,11 @@ public VatAbsenceReasonEnum getVatAbsenceReason() { } + /** + * The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**. + * + * @param vatAbsenceReason + */ @JsonProperty(JSON_PROPERTY_VAT_ABSENCE_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatAbsenceReason(VatAbsenceReasonEnum vatAbsenceReason) { @@ -524,6 +584,11 @@ public String getVatNumber() { } + /** + * The VAT number. + * + * @param vatNumber + */ @JsonProperty(JSON_PROPERTY_VAT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatNumber(String vatNumber) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/UKLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/UKLocalAccountIdentification.java index c88a2c8e3..980a1572b 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/UKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/UKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 8-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getSortCode() { } + /** + * The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. + * + * @param sortCode + */ @JsonProperty(JSON_PROPERTY_SORT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSortCode(String sortCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **ukLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/USLocalAccountIdentification.java b/src/main/java/com/adyen/model/legalentitymanagement/USLocalAccountIdentification.java index 29b6c7a1f..db008dbf4 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/USLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/USLocalAccountIdentification.java @@ -139,6 +139,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -164,6 +169,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -189,6 +199,11 @@ public String getRoutingNumber() { } + /** + * The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. + * + * @param routingNumber + */ @JsonProperty(JSON_PROPERTY_ROUTING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoutingNumber(String routingNumber) { @@ -214,6 +229,11 @@ public TypeEnum getType() { } + /** + * **usLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/UndefinedBeneficiary.java b/src/main/java/com/adyen/model/legalentitymanagement/UndefinedBeneficiary.java index 2e4f2b591..2b9bf69ae 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/UndefinedBeneficiary.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/UndefinedBeneficiary.java @@ -63,6 +63,11 @@ public String getDescription() { } + /** + * The details of the undefined beneficiary. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -88,6 +93,11 @@ public String getReference() { } + /** + * The reference of the undefined beneficiary. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/UnincorporatedPartnership.java b/src/main/java/com/adyen/model/legalentitymanagement/UnincorporatedPartnership.java index 13a0dabb5..d5545f689 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/UnincorporatedPartnership.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/UnincorporatedPartnership.java @@ -78,7 +78,7 @@ public class UnincorporatedPartnership { private List taxInformation = null; /** - * Type of Partnership. Possible values: **limitedPartnership**, **generalPartnership**, **familyPartnership**, **commercialPartnership**, **publicPartnership**, **otherPartnership**, **gbr**, **kgaa**, **cv**, **vof**, **maatschap**, **privateFundLimitedPartnership**, **businessTrustEntity**, or **businessPartnership**. + * Type of Partnership. Possible values: * **limitedPartnership** * **generalPartnership** * **familyPartnership** * **commercialPartnership** * **publicPartnership** * **otherPartnership** * **gbr** * **gmbh** * **kgaa** * **cv** * **vof** * **maatschap** * **privateFundLimitedPartnership** * **businessTrustEntity** * **businessPartnership** */ public enum TypeEnum { LIMITEDPARTNERSHIP("limitedPartnership"), @@ -203,6 +203,11 @@ public String getCountryOfGoverningLaw() { } + /** + * The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country. + * + * @param countryOfGoverningLaw + */ @JsonProperty(JSON_PROPERTY_COUNTRY_OF_GOVERNING_LAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryOfGoverningLaw(String countryOfGoverningLaw) { @@ -228,6 +233,11 @@ public String getDateOfIncorporation() { } + /** + * The date when the legal arrangement was incorporated in YYYY-MM-DD format. + * + * @param dateOfIncorporation + */ @JsonProperty(JSON_PROPERTY_DATE_OF_INCORPORATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfIncorporation(String dateOfIncorporation) { @@ -253,6 +263,11 @@ public String getDescription() { } + /** + * Short description about the Legal Arrangement. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -278,6 +293,11 @@ public String getDoingBusinessAs() { } + /** + * The registered name, if different from the `name`. + * + * @param doingBusinessAs + */ @JsonProperty(JSON_PROPERTY_DOING_BUSINESS_AS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDoingBusinessAs(String doingBusinessAs) { @@ -303,6 +323,11 @@ public String getName() { } + /** + * The legal name. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -328,6 +353,11 @@ public Address getPrincipalPlaceOfBusiness() { } + /** + * principalPlaceOfBusiness + * + * @param principalPlaceOfBusiness + */ @JsonProperty(JSON_PROPERTY_PRINCIPAL_PLACE_OF_BUSINESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrincipalPlaceOfBusiness(Address principalPlaceOfBusiness) { @@ -353,6 +383,11 @@ public Address getRegisteredAddress() { } + /** + * registeredAddress + * + * @param registeredAddress + */ @JsonProperty(JSON_PROPERTY_REGISTERED_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegisteredAddress(Address registeredAddress) { @@ -378,6 +413,11 @@ public String getRegistrationNumber() { } + /** + * The registration number. + * + * @param registrationNumber + */ @JsonProperty(JSON_PROPERTY_REGISTRATION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegistrationNumber(String registrationNumber) { @@ -411,6 +451,11 @@ public List getTaxInformation() { } + /** + * The tax information of the entity. + * + * @param taxInformation + */ @JsonProperty(JSON_PROPERTY_TAX_INFORMATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxInformation(List taxInformation) { @@ -424,10 +469,10 @@ public UnincorporatedPartnership type(TypeEnum type) { } /** - * Type of Partnership. Possible values: **limitedPartnership**, **generalPartnership**, **familyPartnership**, **commercialPartnership**, **publicPartnership**, **otherPartnership**, **gbr**, **kgaa**, **cv**, **vof**, **maatschap**, **privateFundLimitedPartnership**, **businessTrustEntity**, or **businessPartnership**. + * Type of Partnership. Possible values: * **limitedPartnership** * **generalPartnership** * **familyPartnership** * **commercialPartnership** * **publicPartnership** * **otherPartnership** * **gbr** * **gmbh** * **kgaa** * **cv** * **vof** * **maatschap** * **privateFundLimitedPartnership** * **businessTrustEntity** * **businessPartnership** * @return type **/ - @ApiModelProperty(required = true, value = "Type of Partnership. Possible values: **limitedPartnership**, **generalPartnership**, **familyPartnership**, **commercialPartnership**, **publicPartnership**, **otherPartnership**, **gbr**, **kgaa**, **cv**, **vof**, **maatschap**, **privateFundLimitedPartnership**, **businessTrustEntity**, or **businessPartnership**.") + @ApiModelProperty(required = true, value = "Type of Partnership. Possible values: * **limitedPartnership** * **generalPartnership** * **familyPartnership** * **commercialPartnership** * **publicPartnership** * **otherPartnership** * **gbr** * **gmbh** * **kgaa** * **cv** * **vof** * **maatschap** * **privateFundLimitedPartnership** * **businessTrustEntity** * **businessPartnership** ") @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -436,6 +481,11 @@ public TypeEnum getType() { } + /** + * Type of Partnership. Possible values: * **limitedPartnership** * **generalPartnership** * **familyPartnership** * **commercialPartnership** * **publicPartnership** * **otherPartnership** * **gbr** * **gmbh** * **kgaa** * **cv** * **vof** * **maatschap** * **privateFundLimitedPartnership** * **businessTrustEntity** * **businessPartnership** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -461,6 +511,11 @@ public VatAbsenceReasonEnum getVatAbsenceReason() { } + /** + * The reason for not providing a VAT number. Possible values: **industryExemption**, **belowTaxThreshold**. + * + * @param vatAbsenceReason + */ @JsonProperty(JSON_PROPERTY_VAT_ABSENCE_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatAbsenceReason(VatAbsenceReasonEnum vatAbsenceReason) { @@ -486,6 +541,11 @@ public String getVatNumber() { } + /** + * The VAT number. + * + * @param vatNumber + */ @JsonProperty(JSON_PROPERTY_VAT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVatNumber(String vatNumber) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/VerificationDeadline.java b/src/main/java/com/adyen/model/legalentitymanagement/VerificationDeadline.java index 235b33cf7..c6cb0ec00 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/VerificationDeadline.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/VerificationDeadline.java @@ -206,6 +206,11 @@ public List getCapabilities() { } + /** + * The list of capabilities that will be disallowed if information is not reviewed by the time of the deadline + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -239,6 +244,11 @@ public List getEntityIds() { } + /** + * The unique identifiers of the bank account(s) that the deadline applies to + * + * @param entityIds + */ @JsonProperty(JSON_PROPERTY_ENTITY_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityIds(List entityIds) { @@ -264,6 +274,11 @@ public OffsetDateTime getExpiresAt() { } + /** + * The date that verification is due by before capabilities are disallowed. + * + * @param expiresAt + */ @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiresAt(OffsetDateTime expiresAt) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/VerificationError.java b/src/main/java/com/adyen/model/legalentitymanagement/VerificationError.java index b67a2b981..c0c845d3a 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/VerificationError.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/VerificationError.java @@ -263,6 +263,11 @@ public List getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -288,6 +293,11 @@ public String getCode() { } + /** + * The general error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -313,6 +323,11 @@ public String getMessage() { } + /** + * The general error message. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -346,6 +361,11 @@ public List getRemediatingActions() { } + /** + * An object containing possible solutions to fix a verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { @@ -379,6 +399,11 @@ public List getSubErrors() { } + /** + * An array containing more granular information about the cause of the verification error. + * + * @param subErrors + */ @JsonProperty(JSON_PROPERTY_SUB_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubErrors(List subErrors) { @@ -404,6 +429,11 @@ public TypeEnum getType() { } + /** + * The type of error. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrorRecursive.java b/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrorRecursive.java index f923795ef..c047df1b1 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrorRecursive.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrorRecursive.java @@ -259,6 +259,11 @@ public List getCapabilities() { } + /** + * Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(List capabilities) { @@ -284,6 +289,11 @@ public String getCode() { } + /** + * The general error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -309,6 +319,11 @@ public String getMessage() { } + /** + * The general error message. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -334,6 +349,11 @@ public TypeEnum getType() { } + /** + * The type of error. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -367,6 +387,11 @@ public List getRemediatingActions() { } + /** + * An object containing possible solutions to fix a verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrors.java b/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrors.java index fa60f73a7..1eb1820d5 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrors.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/VerificationErrors.java @@ -70,6 +70,11 @@ public List getProblems() { } + /** + * List of the verification errors. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/WebData.java b/src/main/java/com/adyen/model/legalentitymanagement/WebData.java index 644f837e3..0468fa864 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/WebData.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/WebData.java @@ -63,6 +63,11 @@ public String getWebAddress() { } + /** + * The URL of the website or the app store URL. + * + * @param webAddress + */ @JsonProperty(JSON_PROPERTY_WEB_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebAddress(String webAddress) { @@ -88,6 +93,11 @@ public String getWebAddressId() { } + /** + * The unique identifier of the web address. + * + * @param webAddressId + */ @JsonProperty(JSON_PROPERTY_WEB_ADDRESS_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebAddressId(String webAddressId) { diff --git a/src/main/java/com/adyen/model/legalentitymanagement/WebDataExemption.java b/src/main/java/com/adyen/model/legalentitymanagement/WebDataExemption.java index 8954b03c5..2edb41801 100644 --- a/src/main/java/com/adyen/model/legalentitymanagement/WebDataExemption.java +++ b/src/main/java/com/adyen/model/legalentitymanagement/WebDataExemption.java @@ -94,6 +94,11 @@ public ReasonEnum getReason() { } + /** + * The reason why the web data was not provided. Possible value: **noOnlinePresence**. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { diff --git a/src/main/java/com/adyen/model/management/AdditionalCommission.java b/src/main/java/com/adyen/model/management/AdditionalCommission.java index 7bc05a941..f6f327ae1 100644 --- a/src/main/java/com/adyen/model/management/AdditionalCommission.java +++ b/src/main/java/com/adyen/model/management/AdditionalCommission.java @@ -67,6 +67,11 @@ public String getBalanceAccountId() { } + /** + * Unique identifier of the balance account to which the additional commission is booked. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -92,6 +97,11 @@ public Long getFixedAmount() { } + /** + * A fixed commission fee, in minor units. + * + * @param fixedAmount + */ @JsonProperty(JSON_PROPERTY_FIXED_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFixedAmount(Long fixedAmount) { @@ -117,6 +127,11 @@ public Long getVariablePercentage() { } + /** + * A variable commission fee, in basis points. + * + * @param variablePercentage + */ @JsonProperty(JSON_PROPERTY_VARIABLE_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVariablePercentage(Long variablePercentage) { diff --git a/src/main/java/com/adyen/model/management/AdditionalSettings.java b/src/main/java/com/adyen/model/management/AdditionalSettings.java index 18daeb998..4d95b88d7 100644 --- a/src/main/java/com/adyen/model/management/AdditionalSettings.java +++ b/src/main/java/com/adyen/model/management/AdditionalSettings.java @@ -75,6 +75,11 @@ public List getIncludeEventCodes() { } + /** + * Object containing list of event codes for which the notifcation will be sent. + * + * @param includeEventCodes + */ @JsonProperty(JSON_PROPERTY_INCLUDE_EVENT_CODES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIncludeEventCodes(List includeEventCodes) { @@ -108,6 +113,11 @@ public Map getProperties() { } + /** + * Object containing boolean key-value pairs. The key can be any [standard webhook additional setting](https://docs.adyen.com/development-resources/webhooks/additional-settings), and the value indicates if the setting is enabled. For example, `captureDelayHours`: **true** means the standard notifications you get will contain the number of hours remaining until the payment will be captured. + * + * @param properties + */ @JsonProperty(JSON_PROPERTY_PROPERTIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProperties(Map properties) { diff --git a/src/main/java/com/adyen/model/management/AdditionalSettingsResponse.java b/src/main/java/com/adyen/model/management/AdditionalSettingsResponse.java index 8cf2415eb..9db658a01 100644 --- a/src/main/java/com/adyen/model/management/AdditionalSettingsResponse.java +++ b/src/main/java/com/adyen/model/management/AdditionalSettingsResponse.java @@ -79,6 +79,11 @@ public List getExcludeEventCodes() { } + /** + * Object containing list of event codes for which the notifcation will not be sent. + * + * @param excludeEventCodes + */ @JsonProperty(JSON_PROPERTY_EXCLUDE_EVENT_CODES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExcludeEventCodes(List excludeEventCodes) { @@ -112,6 +117,11 @@ public List getIncludeEventCodes() { } + /** + * Object containing list of event codes for which the notifcation will be sent. + * + * @param includeEventCodes + */ @JsonProperty(JSON_PROPERTY_INCLUDE_EVENT_CODES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIncludeEventCodes(List includeEventCodes) { @@ -145,6 +155,11 @@ public Map getProperties() { } + /** + * Object containing boolean key-value pairs. The key can be any [standard webhook additional setting](https://docs.adyen.com/development-resources/webhooks/additional-settings), and the value indicates if the setting is enabled. For example, `captureDelayHours`: **true** means the standard notifications you get will contain the number of hours remaining until the payment will be captured. + * + * @param properties + */ @JsonProperty(JSON_PROPERTY_PROPERTIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProperties(Map properties) { diff --git a/src/main/java/com/adyen/model/management/Address.java b/src/main/java/com/adyen/model/management/Address.java index d700f79f4..a2b7e79d3 100644 --- a/src/main/java/com/adyen/model/management/Address.java +++ b/src/main/java/com/adyen/model/management/Address.java @@ -83,6 +83,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -108,6 +113,11 @@ public String getCompanyName() { } + /** + * The name of the company. + * + * @param companyName + */ @JsonProperty(JSON_PROPERTY_COMPANY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyName(String companyName) { @@ -133,6 +143,11 @@ public String getCountry() { } + /** + * The two-letter country code, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -158,6 +173,11 @@ public String getPostalCode() { } + /** + * The postal code. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -183,6 +203,11 @@ public String getStateOrProvince() { } + /** + * The state or province as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada. Applicable for the following countries: - Australia - Brazil - Canada - India - Mexico - New Zealand - United States + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -208,6 +233,11 @@ public String getStreetAddress() { } + /** + * The name of the street, and the house or building number. + * + * @param streetAddress + */ @JsonProperty(JSON_PROPERTY_STREET_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreetAddress(String streetAddress) { @@ -233,6 +263,11 @@ public String getStreetAddress2() { } + /** + * Additional address details, if any. + * + * @param streetAddress2 + */ @JsonProperty(JSON_PROPERTY_STREET_ADDRESS2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreetAddress2(String streetAddress2) { diff --git a/src/main/java/com/adyen/model/management/AfterpayTouchInfo.java b/src/main/java/com/adyen/model/management/AfterpayTouchInfo.java index 4c48f420d..01feed021 100644 --- a/src/main/java/com/adyen/model/management/AfterpayTouchInfo.java +++ b/src/main/java/com/adyen/model/management/AfterpayTouchInfo.java @@ -59,6 +59,11 @@ public String getSupportUrl() { } + /** + * Support Url + * + * @param supportUrl + */ @JsonProperty(JSON_PROPERTY_SUPPORT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportUrl(String supportUrl) { diff --git a/src/main/java/com/adyen/model/management/AllowedOrigin.java b/src/main/java/com/adyen/model/management/AllowedOrigin.java index ea9a02516..cfca347b2 100644 --- a/src/main/java/com/adyen/model/management/AllowedOrigin.java +++ b/src/main/java/com/adyen/model/management/AllowedOrigin.java @@ -68,6 +68,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -93,6 +98,11 @@ public String getDomain() { } + /** + * Domain of the allowed origin. + * + * @param domain + */ @JsonProperty(JSON_PROPERTY_DOMAIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomain(String domain) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * Unique identifier of the allowed origin. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/management/AllowedOriginsResponse.java b/src/main/java/com/adyen/model/management/AllowedOriginsResponse.java index eef335027..e0f6e6edc 100644 --- a/src/main/java/com/adyen/model/management/AllowedOriginsResponse.java +++ b/src/main/java/com/adyen/model/management/AllowedOriginsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * List of allowed origins. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/Amount.java b/src/main/java/com/adyen/model/management/Amount.java index 8cf193def..23131e99a 100644 --- a/src/main/java/com/adyen/model/management/Amount.java +++ b/src/main/java/com/adyen/model/management/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/management/AndroidApp.java b/src/main/java/com/adyen/model/management/AndroidApp.java index 9be341082..d7a15f0cc 100644 --- a/src/main/java/com/adyen/model/management/AndroidApp.java +++ b/src/main/java/com/adyen/model/management/AndroidApp.java @@ -87,6 +87,11 @@ public String getDescription() { } + /** + * The description that was provided when uploading the app. The description is not shown on the terminal. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -112,6 +117,11 @@ public String getErrorCode() { } + /** + * The error code of the app. It exists if the status is error or invalid. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -137,6 +147,11 @@ public String getId() { } + /** + * The unique identifier of the app. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -162,6 +177,11 @@ public String getLabel() { } + /** + * The app name that is shown on the terminal. + * + * @param label + */ @JsonProperty(JSON_PROPERTY_LABEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLabel(String label) { @@ -187,6 +207,11 @@ public String getPackageName() { } + /** + * The package name that uniquely identifies the Android app. + * + * @param packageName + */ @JsonProperty(JSON_PROPERTY_PACKAGE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPackageName(String packageName) { @@ -212,6 +237,11 @@ public String getStatus() { } + /** + * The status of the app. Possible values: * `processing`: the app is being signed and converted to a format that the terminal can handle. * `error`: something went wrong. Check that the app matches the [requirements](https://docs.adyen.com/point-of-sale/android-terminals/app-requirements). * `invalid`: there is something wrong with the APK file of the app. * `ready`: the app has been signed and converted. * `archived`: the app is no longer available. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { @@ -237,6 +267,11 @@ public Integer getVersionCode() { } + /** + * The version number of the app. + * + * @param versionCode + */ @JsonProperty(JSON_PROPERTY_VERSION_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersionCode(Integer versionCode) { @@ -262,6 +297,11 @@ public String getVersionName() { } + /** + * The app version number that is shown on the terminal. + * + * @param versionName + */ @JsonProperty(JSON_PROPERTY_VERSION_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersionName(String versionName) { diff --git a/src/main/java/com/adyen/model/management/AndroidAppsResponse.java b/src/main/java/com/adyen/model/management/AndroidAppsResponse.java index ef5b75446..8468d52b3 100644 --- a/src/main/java/com/adyen/model/management/AndroidAppsResponse.java +++ b/src/main/java/com/adyen/model/management/AndroidAppsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * Apps uploaded for Android payment terminals. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/AndroidCertificate.java b/src/main/java/com/adyen/model/management/AndroidCertificate.java index 3663c618f..753fdfb06 100644 --- a/src/main/java/com/adyen/model/management/AndroidCertificate.java +++ b/src/main/java/com/adyen/model/management/AndroidCertificate.java @@ -84,6 +84,11 @@ public String getDescription() { } + /** + * The description that was provided when uploading the certificate. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -109,6 +114,11 @@ public String getExtension() { } + /** + * The file format of the certificate, as indicated by the file extension. For example, **.cert** or **.pem**. + * + * @param extension + */ @JsonProperty(JSON_PROPERTY_EXTENSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtension(String extension) { @@ -134,6 +144,11 @@ public String getId() { } + /** + * The unique identifier of the certificate. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -159,6 +174,11 @@ public String getName() { } + /** + * The file name of the certificate. For example, **mycert**. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -184,6 +204,11 @@ public OffsetDateTime getNotAfter() { } + /** + * The date when the certificate stops to be valid. + * + * @param notAfter + */ @JsonProperty(JSON_PROPERTY_NOT_AFTER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotAfter(OffsetDateTime notAfter) { @@ -209,6 +234,11 @@ public OffsetDateTime getNotBefore() { } + /** + * The date when the certificate starts to be valid. + * + * @param notBefore + */ @JsonProperty(JSON_PROPERTY_NOT_BEFORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotBefore(OffsetDateTime notBefore) { @@ -234,6 +264,11 @@ public String getStatus() { } + /** + * The status of the certificate. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/management/AndroidCertificatesResponse.java b/src/main/java/com/adyen/model/management/AndroidCertificatesResponse.java index dafedfc9f..c00d592ea 100644 --- a/src/main/java/com/adyen/model/management/AndroidCertificatesResponse.java +++ b/src/main/java/com/adyen/model/management/AndroidCertificatesResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * Uploaded Android certificates for Android payment terminals. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/ApiCredential.java b/src/main/java/com/adyen/model/management/ApiCredential.java index d738b872e..ddbe089d6 100644 --- a/src/main/java/com/adyen/model/management/ApiCredential.java +++ b/src/main/java/com/adyen/model/management/ApiCredential.java @@ -95,6 +95,11 @@ public ApiCredentialLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(ApiCredentialLinks links) { @@ -120,6 +125,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -150,6 +160,11 @@ public List getAllowedIpAddresses() { } + /** + * List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error. + * + * @param allowedIpAddresses + */ @JsonProperty(JSON_PROPERTY_ALLOWED_IP_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedIpAddresses(List allowedIpAddresses) { @@ -183,6 +198,11 @@ public List getAllowedOrigins() { } + /** + * List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -208,6 +228,11 @@ public String getClientKey() { } + /** + * Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations. + * + * @param clientKey + */ @JsonProperty(JSON_PROPERTY_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientKey(String clientKey) { @@ -233,6 +258,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -258,6 +288,11 @@ public String getId() { } + /** + * Unique identifier of the API credential. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -288,6 +323,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -313,6 +353,11 @@ public String getUsername() { } + /** + * The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/ApiCredentialLinks.java b/src/main/java/com/adyen/model/management/ApiCredentialLinks.java index 0b73f2a02..aa22231d0 100644 --- a/src/main/java/com/adyen/model/management/ApiCredentialLinks.java +++ b/src/main/java/com/adyen/model/management/ApiCredentialLinks.java @@ -80,6 +80,11 @@ public LinksElement getAllowedOrigins() { } + /** + * allowedOrigins + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(LinksElement allowedOrigins) { @@ -105,6 +110,11 @@ public LinksElement getCompany() { } + /** + * company + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(LinksElement company) { @@ -130,6 +140,11 @@ public LinksElement getGenerateApiKey() { } + /** + * generateApiKey + * + * @param generateApiKey + */ @JsonProperty(JSON_PROPERTY_GENERATE_API_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGenerateApiKey(LinksElement generateApiKey) { @@ -155,6 +170,11 @@ public LinksElement getGenerateClientKey() { } + /** + * generateClientKey + * + * @param generateClientKey + */ @JsonProperty(JSON_PROPERTY_GENERATE_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGenerateClientKey(LinksElement generateClientKey) { @@ -180,6 +200,11 @@ public LinksElement getMerchant() { } + /** + * merchant + * + * @param merchant + */ @JsonProperty(JSON_PROPERTY_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchant(LinksElement merchant) { @@ -205,6 +230,11 @@ public LinksElement getSelf() { } + /** + * self + * + * @param self + */ @JsonProperty(JSON_PROPERTY_SELF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelf(LinksElement self) { diff --git a/src/main/java/com/adyen/model/management/ApplePayInfo.java b/src/main/java/com/adyen/model/management/ApplePayInfo.java index 58c75823d..e6133e6c9 100644 --- a/src/main/java/com/adyen/model/management/ApplePayInfo.java +++ b/src/main/java/com/adyen/model/management/ApplePayInfo.java @@ -66,6 +66,11 @@ public List getDomains() { } + /** + * The list of merchant domains. Maximum: 99 domains per request. For more information, see [Apple Pay documentation](https://docs.adyen.com/payment-methods/apple-pay/web-drop-in?tab=adyen-certificate-live_1#going-live). + * + * @param domains + */ @JsonProperty(JSON_PROPERTY_DOMAINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomains(List domains) { diff --git a/src/main/java/com/adyen/model/management/BcmcInfo.java b/src/main/java/com/adyen/model/management/BcmcInfo.java index af3b824be..2416e0f74 100644 --- a/src/main/java/com/adyen/model/management/BcmcInfo.java +++ b/src/main/java/com/adyen/model/management/BcmcInfo.java @@ -64,6 +64,11 @@ public Boolean getEnableBcmcMobile() { } + /** + * Indicates if [Bancontact mobile](https://docs.adyen.com/payment-methods/bancontact/bancontact-mobile) is enabled. + * + * @param enableBcmcMobile + */ @JsonProperty(JSON_PROPERTY_ENABLE_BCMC_MOBILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableBcmcMobile(Boolean enableBcmcMobile) { @@ -89,6 +94,11 @@ public TransactionDescriptionInfo getTransactionDescription() { } + /** + * transactionDescription + * + * @param transactionDescription + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionDescription(TransactionDescriptionInfo transactionDescription) { diff --git a/src/main/java/com/adyen/model/management/BillingEntitiesResponse.java b/src/main/java/com/adyen/model/management/BillingEntitiesResponse.java index d1a8bc5bd..6d73a38d7 100644 --- a/src/main/java/com/adyen/model/management/BillingEntitiesResponse.java +++ b/src/main/java/com/adyen/model/management/BillingEntitiesResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * List of legal entities that can be used for the billing of orders. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/BillingEntity.java b/src/main/java/com/adyen/model/management/BillingEntity.java index c9e8b7120..330870b1d 100644 --- a/src/main/java/com/adyen/model/management/BillingEntity.java +++ b/src/main/java/com/adyen/model/management/BillingEntity.java @@ -76,6 +76,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -101,6 +106,11 @@ public String getEmail() { } + /** + * The email address of the billing entity. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -126,6 +136,11 @@ public String getId() { } + /** + * The unique identifier of the billing entity, for use as `billingEntityId` when creating an order. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -151,6 +166,11 @@ public String getName() { } + /** + * The unique name of the billing entity. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -176,6 +196,11 @@ public String getTaxId() { } + /** + * The tax number of the billing entity. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/management/CardholderReceipt.java b/src/main/java/com/adyen/model/management/CardholderReceipt.java index fadbac908..1f46234e8 100644 --- a/src/main/java/com/adyen/model/management/CardholderReceipt.java +++ b/src/main/java/com/adyen/model/management/CardholderReceipt.java @@ -59,6 +59,11 @@ public String getHeaderForAuthorizedReceipt() { } + /** + * A custom header to show on the shopper receipt for an authorised transaction. Allows one or two comma-separated header lines, and blank lines. For example, `header,header,filler` + * + * @param headerForAuthorizedReceipt + */ @JsonProperty(JSON_PROPERTY_HEADER_FOR_AUTHORIZED_RECEIPT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHeaderForAuthorizedReceipt(String headerForAuthorizedReceipt) { diff --git a/src/main/java/com/adyen/model/management/CartesBancairesInfo.java b/src/main/java/com/adyen/model/management/CartesBancairesInfo.java index 9e4816265..241b3adea 100644 --- a/src/main/java/com/adyen/model/management/CartesBancairesInfo.java +++ b/src/main/java/com/adyen/model/management/CartesBancairesInfo.java @@ -64,6 +64,11 @@ public String getSiret() { } + /** + * Cartes Bancaires SIRET. Format: 14 digits. + * + * @param siret + */ @JsonProperty(JSON_PROPERTY_SIRET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSiret(String siret) { @@ -89,6 +94,11 @@ public TransactionDescriptionInfo getTransactionDescription() { } + /** + * transactionDescription + * + * @param transactionDescription + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionDescription(TransactionDescriptionInfo transactionDescription) { diff --git a/src/main/java/com/adyen/model/management/ClearpayInfo.java b/src/main/java/com/adyen/model/management/ClearpayInfo.java index 8b0a975f8..c18bdc18b 100644 --- a/src/main/java/com/adyen/model/management/ClearpayInfo.java +++ b/src/main/java/com/adyen/model/management/ClearpayInfo.java @@ -59,6 +59,11 @@ public String getSupportUrl() { } + /** + * Support Url + * + * @param supportUrl + */ @JsonProperty(JSON_PROPERTY_SUPPORT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportUrl(String supportUrl) { diff --git a/src/main/java/com/adyen/model/management/Commission.java b/src/main/java/com/adyen/model/management/Commission.java index c9c6a585f..94bcee9f5 100644 --- a/src/main/java/com/adyen/model/management/Commission.java +++ b/src/main/java/com/adyen/model/management/Commission.java @@ -63,6 +63,11 @@ public Long getFixedAmount() { } + /** + * A fixed commission fee, in minor units. + * + * @param fixedAmount + */ @JsonProperty(JSON_PROPERTY_FIXED_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFixedAmount(Long fixedAmount) { @@ -88,6 +93,11 @@ public Long getVariablePercentage() { } + /** + * A variable commission fee, in basis points. + * + * @param variablePercentage + */ @JsonProperty(JSON_PROPERTY_VARIABLE_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVariablePercentage(Long variablePercentage) { diff --git a/src/main/java/com/adyen/model/management/Company.java b/src/main/java/com/adyen/model/management/Company.java index aa035afbc..ac609bd4c 100644 --- a/src/main/java/com/adyen/model/management/Company.java +++ b/src/main/java/com/adyen/model/management/Company.java @@ -87,6 +87,11 @@ public CompanyLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(CompanyLinks links) { @@ -120,6 +125,11 @@ public List getDataCenters() { } + /** + * List of available data centers. Adyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers. + * + * @param dataCenters + */ @JsonProperty(JSON_PROPERTY_DATA_CENTERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDataCenters(List dataCenters) { @@ -145,6 +155,11 @@ public String getDescription() { } + /** + * Your description for the company account, maximum 300 characters + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -170,6 +185,11 @@ public String getId() { } + /** + * The unique identifier of the company account. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -195,6 +215,11 @@ public String getName() { } + /** + * The legal or trading name of the company. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -220,6 +245,11 @@ public String getReference() { } + /** + * Your reference to the account + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -245,6 +275,11 @@ public String getStatus() { } + /** + * The status of the company account. Possible values: * **Active**: Users can log in. Processing and payout capabilities depend on the status of the merchant account. * **Inactive**: Users can log in. Payment processing and payouts are disabled. * **Closed**: The company account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/management/CompanyApiCredential.java b/src/main/java/com/adyen/model/management/CompanyApiCredential.java index 351e69ab4..0b7b26a6f 100644 --- a/src/main/java/com/adyen/model/management/CompanyApiCredential.java +++ b/src/main/java/com/adyen/model/management/CompanyApiCredential.java @@ -99,6 +99,11 @@ public ApiCredentialLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(ApiCredentialLinks links) { @@ -124,6 +129,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -154,6 +164,11 @@ public List getAllowedIpAddresses() { } + /** + * List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error. + * + * @param allowedIpAddresses + */ @JsonProperty(JSON_PROPERTY_ALLOWED_IP_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedIpAddresses(List allowedIpAddresses) { @@ -187,6 +202,11 @@ public List getAllowedOrigins() { } + /** + * List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -220,6 +240,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -245,6 +270,11 @@ public String getClientKey() { } + /** + * Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations. + * + * @param clientKey + */ @JsonProperty(JSON_PROPERTY_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientKey(String clientKey) { @@ -270,6 +300,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -295,6 +330,11 @@ public String getId() { } + /** + * Unique identifier of the API credential. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -325,6 +365,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -350,6 +395,11 @@ public String getUsername() { } + /** + * The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CompanyLinks.java b/src/main/java/com/adyen/model/management/CompanyLinks.java index b93637194..74c754674 100644 --- a/src/main/java/com/adyen/model/management/CompanyLinks.java +++ b/src/main/java/com/adyen/model/management/CompanyLinks.java @@ -72,6 +72,11 @@ public LinksElement getApiCredentials() { } + /** + * apiCredentials + * + * @param apiCredentials + */ @JsonProperty(JSON_PROPERTY_API_CREDENTIALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiCredentials(LinksElement apiCredentials) { @@ -97,6 +102,11 @@ public LinksElement getSelf() { } + /** + * self + * + * @param self + */ @JsonProperty(JSON_PROPERTY_SELF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelf(LinksElement self) { @@ -122,6 +132,11 @@ public LinksElement getUsers() { } + /** + * users + * + * @param users + */ @JsonProperty(JSON_PROPERTY_USERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsers(LinksElement users) { @@ -147,6 +162,11 @@ public LinksElement getWebhooks() { } + /** + * webhooks + * + * @param webhooks + */ @JsonProperty(JSON_PROPERTY_WEBHOOKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebhooks(LinksElement webhooks) { diff --git a/src/main/java/com/adyen/model/management/CompanyUser.java b/src/main/java/com/adyen/model/management/CompanyUser.java index 720aa339b..c2f998630 100644 --- a/src/main/java/com/adyen/model/management/CompanyUser.java +++ b/src/main/java/com/adyen/model/management/CompanyUser.java @@ -103,6 +103,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -136,6 +141,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -161,6 +171,11 @@ public Boolean getActive() { } + /** + * Indicates whether this user is active. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -194,6 +209,11 @@ public List getApps() { } + /** + * Set of apps available to this user + * + * @param apps + */ @JsonProperty(JSON_PROPERTY_APPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApps(List apps) { @@ -227,6 +247,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -252,6 +277,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -277,6 +307,11 @@ public String getId() { } + /** + * The unique identifier of the user. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -302,6 +337,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -332,6 +372,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -357,6 +402,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { @@ -382,6 +432,11 @@ public String getUsername() { } + /** + * The username for this user. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/Connectivity.java b/src/main/java/com/adyen/model/management/Connectivity.java index 88f5c8645..2d79e66ea 100644 --- a/src/main/java/com/adyen/model/management/Connectivity.java +++ b/src/main/java/com/adyen/model/management/Connectivity.java @@ -94,6 +94,11 @@ public SimcardStatusEnum getSimcardStatus() { } + /** + * Indicates the status of the SIM card in the payment terminal. Can be updated and received only at terminal level, and only for models that support cellular connectivity. Possible values: * **ACTIVATED**: the SIM card is activated. Cellular connectivity may still need to be enabled on the terminal itself, in the **Network** settings. * **INVENTORY**: the SIM card is not activated. The terminal can't use cellular connectivity. + * + * @param simcardStatus + */ @JsonProperty(JSON_PROPERTY_SIMCARD_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSimcardStatus(SimcardStatusEnum simcardStatus) { diff --git a/src/main/java/com/adyen/model/management/Contact.java b/src/main/java/com/adyen/model/management/Contact.java index 66e6617f2..cfa41ebc3 100644 --- a/src/main/java/com/adyen/model/management/Contact.java +++ b/src/main/java/com/adyen/model/management/Contact.java @@ -75,6 +75,11 @@ public String getEmail() { } + /** + * The individual's email address. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -100,6 +105,11 @@ public String getFirstName() { } + /** + * The individual's first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -125,6 +135,11 @@ public String getInfix() { } + /** + * The infix in the individual's name, if any. + * + * @param infix + */ @JsonProperty(JSON_PROPERTY_INFIX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInfix(String infix) { @@ -150,6 +165,11 @@ public String getLastName() { } + /** + * The individual's last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -175,6 +195,11 @@ public String getPhoneNumber() { } + /** + * The individual's phone number, specified as 10-14 digits with an optional `+` prefix. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { diff --git a/src/main/java/com/adyen/model/management/CreateAllowedOriginRequest.java b/src/main/java/com/adyen/model/management/CreateAllowedOriginRequest.java index 58557525e..6304ae0a8 100644 --- a/src/main/java/com/adyen/model/management/CreateAllowedOriginRequest.java +++ b/src/main/java/com/adyen/model/management/CreateAllowedOriginRequest.java @@ -68,6 +68,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -93,6 +98,11 @@ public String getDomain() { } + /** + * Domain of the allowed origin. + * + * @param domain + */ @JsonProperty(JSON_PROPERTY_DOMAIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomain(String domain) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * Unique identifier of the allowed origin. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/management/CreateApiCredentialResponse.java b/src/main/java/com/adyen/model/management/CreateApiCredentialResponse.java index 64ca8d459..9640205d1 100644 --- a/src/main/java/com/adyen/model/management/CreateApiCredentialResponse.java +++ b/src/main/java/com/adyen/model/management/CreateApiCredentialResponse.java @@ -103,6 +103,11 @@ public ApiCredentialLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(ApiCredentialLinks links) { @@ -128,6 +133,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -158,6 +168,11 @@ public List getAllowedIpAddresses() { } + /** + * List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error. + * + * @param allowedIpAddresses + */ @JsonProperty(JSON_PROPERTY_ALLOWED_IP_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedIpAddresses(List allowedIpAddresses) { @@ -191,6 +206,11 @@ public List getAllowedOrigins() { } + /** + * List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -216,6 +236,11 @@ public String getApiKey() { } + /** + * The API key for the API credential that was created. + * + * @param apiKey + */ @JsonProperty(JSON_PROPERTY_API_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiKey(String apiKey) { @@ -241,6 +266,11 @@ public String getClientKey() { } + /** + * Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations. + * + * @param clientKey + */ @JsonProperty(JSON_PROPERTY_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientKey(String clientKey) { @@ -266,6 +296,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -291,6 +326,11 @@ public String getId() { } + /** + * Unique identifier of the API credential. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -316,6 +356,11 @@ public String getPassword() { } + /** + * The password for the API credential that was created. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -346,6 +391,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -371,6 +421,11 @@ public String getUsername() { } + /** + * The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialRequest.java b/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialRequest.java index 1e38e0698..4fd131000 100644 --- a/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialRequest.java +++ b/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialRequest.java @@ -81,6 +81,11 @@ public List getAllowedOrigins() { } + /** + * List of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -114,6 +119,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * List of merchant accounts that the API credential has access to. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -139,6 +149,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -172,6 +187,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { diff --git a/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialResponse.java b/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialResponse.java index 5fe2c11d3..b9a36512e 100644 --- a/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialResponse.java +++ b/src/main/java/com/adyen/model/management/CreateCompanyApiCredentialResponse.java @@ -107,6 +107,11 @@ public ApiCredentialLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(ApiCredentialLinks links) { @@ -132,6 +137,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -162,6 +172,11 @@ public List getAllowedIpAddresses() { } + /** + * List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error. + * + * @param allowedIpAddresses + */ @JsonProperty(JSON_PROPERTY_ALLOWED_IP_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedIpAddresses(List allowedIpAddresses) { @@ -195,6 +210,11 @@ public List getAllowedOrigins() { } + /** + * List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -220,6 +240,11 @@ public String getApiKey() { } + /** + * The API key for the API credential that was created. + * + * @param apiKey + */ @JsonProperty(JSON_PROPERTY_API_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiKey(String apiKey) { @@ -250,6 +275,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * List of merchant accounts that the API credential has access to. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -275,6 +305,11 @@ public String getClientKey() { } + /** + * Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations. + * + * @param clientKey + */ @JsonProperty(JSON_PROPERTY_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientKey(String clientKey) { @@ -300,6 +335,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -325,6 +365,11 @@ public String getId() { } + /** + * Unique identifier of the API credential. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -350,6 +395,11 @@ public String getPassword() { } + /** + * The password for the API credential that was created. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -380,6 +430,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -405,6 +460,11 @@ public String getUsername() { } + /** + * The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateCompanyUserRequest.java b/src/main/java/com/adyen/model/management/CreateCompanyUserRequest.java index 2cc976132..56deed405 100644 --- a/src/main/java/com/adyen/model/management/CreateCompanyUserRequest.java +++ b/src/main/java/com/adyen/model/management/CreateCompanyUserRequest.java @@ -94,6 +94,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -127,6 +132,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -152,6 +162,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -177,6 +192,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -210,6 +230,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -235,6 +260,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { @@ -260,6 +290,11 @@ public String getUsername() { } + /** + * The user's email address that will be their username. Must be the same as the one in the `email` field. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateCompanyUserResponse.java b/src/main/java/com/adyen/model/management/CreateCompanyUserResponse.java index 558467480..b65593bd8 100644 --- a/src/main/java/com/adyen/model/management/CreateCompanyUserResponse.java +++ b/src/main/java/com/adyen/model/management/CreateCompanyUserResponse.java @@ -103,6 +103,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -136,6 +141,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -161,6 +171,11 @@ public Boolean getActive() { } + /** + * Indicates whether this user is active. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -194,6 +209,11 @@ public List getApps() { } + /** + * Set of apps available to this user + * + * @param apps + */ @JsonProperty(JSON_PROPERTY_APPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApps(List apps) { @@ -227,6 +247,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) associated with this user. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -252,6 +277,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -277,6 +307,11 @@ public String getId() { } + /** + * The unique identifier of the user. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -302,6 +337,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -332,6 +372,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -357,6 +402,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { @@ -382,6 +432,11 @@ public String getUsername() { } + /** + * The username for this user. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateCompanyWebhookRequest.java b/src/main/java/com/adyen/model/management/CreateCompanyWebhookRequest.java index bf9006c21..d5d66daba 100644 --- a/src/main/java/com/adyen/model/management/CreateCompanyWebhookRequest.java +++ b/src/main/java/com/adyen/model/management/CreateCompanyWebhookRequest.java @@ -268,6 +268,11 @@ public Boolean getAcceptsExpiredCertificate() { } + /** + * Indicates if expired SSL certificates are accepted. Default value: **false**. + * + * @param acceptsExpiredCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate) { @@ -293,6 +298,11 @@ public Boolean getAcceptsSelfSignedCertificate() { } + /** + * Indicates if self-signed SSL certificates are accepted. Default value: **false**. + * + * @param acceptsSelfSignedCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate) { @@ -318,6 +328,11 @@ public Boolean getAcceptsUntrustedRootCertificate() { } + /** + * Indicates if untrusted SSL certificates are accepted. Default value: **false**. + * + * @param acceptsUntrustedRootCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate) { @@ -343,6 +358,11 @@ public Boolean getActive() { } + /** + * Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -368,6 +388,11 @@ public AdditionalSettings getAdditionalSettings() { } + /** + * additionalSettings + * + * @param additionalSettings + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalSettings(AdditionalSettings additionalSettings) { @@ -393,6 +418,11 @@ public CommunicationFormatEnum getCommunicationFormat() { } + /** + * Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json** + * + * @param communicationFormat + */ @JsonProperty(JSON_PROPERTY_COMMUNICATION_FORMAT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommunicationFormat(CommunicationFormatEnum communicationFormat) { @@ -418,6 +448,11 @@ public String getDescription() { } + /** + * Your description for this webhook configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -443,6 +478,11 @@ public EncryptionProtocolEnum getEncryptionProtocol() { } + /** + * SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**. + * + * @param encryptionProtocol + */ @JsonProperty(JSON_PROPERTY_ENCRYPTION_PROTOCOL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptionProtocol(EncryptionProtocolEnum encryptionProtocol) { @@ -468,6 +508,11 @@ public FilterMerchantAccountTypeEnum getFilterMerchantAccountType() { } + /** + * Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **allAccounts** : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. * **includeAccounts** : The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * **excludeAccounts** : The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. + * + * @param filterMerchantAccountType + */ @JsonProperty(JSON_PROPERTY_FILTER_MERCHANT_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFilterMerchantAccountType(FilterMerchantAccountTypeEnum filterMerchantAccountType) { @@ -498,6 +543,11 @@ public List getFilterMerchantAccounts() { } + /** + * A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts** Not needed for `filterMerchantAccountType`: **allAccounts**. + * + * @param filterMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_FILTER_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFilterMerchantAccounts(List filterMerchantAccounts) { @@ -523,6 +573,11 @@ public NetworkTypeEnum getNetworkType() { } + /** + * Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**. + * + * @param networkType + */ @JsonProperty(JSON_PROPERTY_NETWORK_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkType(NetworkTypeEnum networkType) { @@ -548,6 +603,11 @@ public String getPassword() { } + /** + * Password to access the webhook URL. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -573,6 +633,11 @@ public Boolean getPopulateSoapActionHeader() { } + /** + * Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**. + * + * @param populateSoapActionHeader + */ @JsonProperty(JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPopulateSoapActionHeader(Boolean populateSoapActionHeader) { @@ -598,6 +663,11 @@ public String getType() { } + /** + * The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -623,6 +693,11 @@ public String getUrl() { } + /** + * Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -648,6 +723,11 @@ public String getUsername() { } + /** + * Username to access the webhook URL. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateMerchantApiCredentialRequest.java b/src/main/java/com/adyen/model/management/CreateMerchantApiCredentialRequest.java index d024df154..e1bdb2042 100644 --- a/src/main/java/com/adyen/model/management/CreateMerchantApiCredentialRequest.java +++ b/src/main/java/com/adyen/model/management/CreateMerchantApiCredentialRequest.java @@ -77,6 +77,11 @@ public List getAllowedOrigins() { } + /** + * The list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the new API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -102,6 +107,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -135,6 +145,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { diff --git a/src/main/java/com/adyen/model/management/CreateMerchantRequest.java b/src/main/java/com/adyen/model/management/CreateMerchantRequest.java index c4ea97fc6..e2de6794d 100644 --- a/src/main/java/com/adyen/model/management/CreateMerchantRequest.java +++ b/src/main/java/com/adyen/model/management/CreateMerchantRequest.java @@ -85,6 +85,11 @@ public String getBusinessLineId() { } + /** + * The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration. + * + * @param businessLineId + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineId(String businessLineId) { @@ -110,6 +115,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -135,6 +145,11 @@ public String getDescription() { } + /** + * Your description for the merchant account, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -160,6 +175,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). Required for an Adyen for Platforms Manage integration. + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -185,6 +205,11 @@ public String getPricingPlan() { } + /** + * Sets the pricing plan for the merchant account. Required for an Adyen for Platforms Manage integration. Your Adyen contact will provide the values that you can use. + * + * @param pricingPlan + */ @JsonProperty(JSON_PROPERTY_PRICING_PLAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPricingPlan(String pricingPlan) { @@ -210,6 +235,11 @@ public String getReference() { } + /** + * Your reference for the merchant account. To make this reference the unique identifier of the merchant account, your Adyen contact can set up a template on your company account. The template can have 6 to 255 characters with upper- and lower-case letters, underscores, and numbers. When your company account has a template, then the `reference` is required and must be unique within the company account. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -243,6 +273,11 @@ public List getSalesChannels() { } + /** + * List of sales channels that the merchant will process payments with + * + * @param salesChannels + */ @JsonProperty(JSON_PROPERTY_SALES_CHANNELS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSalesChannels(List salesChannels) { diff --git a/src/main/java/com/adyen/model/management/CreateMerchantResponse.java b/src/main/java/com/adyen/model/management/CreateMerchantResponse.java index f465fc5cf..3e4a20dfa 100644 --- a/src/main/java/com/adyen/model/management/CreateMerchantResponse.java +++ b/src/main/java/com/adyen/model/management/CreateMerchantResponse.java @@ -83,6 +83,11 @@ public String getBusinessLineId() { } + /** + * The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). + * + * @param businessLineId + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineId(String businessLineId) { @@ -108,6 +113,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -133,6 +143,11 @@ public String getDescription() { } + /** + * Your description for the merchant account, maximum 300 characters. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -158,6 +173,11 @@ public String getId() { } + /** + * The unique identifier of the merchant account. If Adyen set up a template for the `reference`, then the `id` will have the same value as the `reference` that you sent in the request. Otherwise, the value is generated by Adyen. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -183,6 +203,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -208,6 +233,11 @@ public String getPricingPlan() { } + /** + * Partner pricing plan for the merchant, applicable for merchants under AfP managed company accounts. + * + * @param pricingPlan + */ @JsonProperty(JSON_PROPERTY_PRICING_PLAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPricingPlan(String pricingPlan) { @@ -233,6 +263,11 @@ public String getReference() { } + /** + * Your reference for the merchant account. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/management/CreateMerchantUserRequest.java b/src/main/java/com/adyen/model/management/CreateMerchantUserRequest.java index 39e08f5b3..dba7ddb13 100644 --- a/src/main/java/com/adyen/model/management/CreateMerchantUserRequest.java +++ b/src/main/java/com/adyen/model/management/CreateMerchantUserRequest.java @@ -90,6 +90,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -115,6 +120,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -140,6 +150,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -173,6 +188,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -198,6 +218,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { @@ -223,6 +248,11 @@ public String getUsername() { } + /** + * The user's email address that will be their username. Must be the same as the one in the `email` field. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateMerchantWebhookRequest.java b/src/main/java/com/adyen/model/management/CreateMerchantWebhookRequest.java index 4a6dffb20..40b686ca8 100644 --- a/src/main/java/com/adyen/model/management/CreateMerchantWebhookRequest.java +++ b/src/main/java/com/adyen/model/management/CreateMerchantWebhookRequest.java @@ -221,6 +221,11 @@ public Boolean getAcceptsExpiredCertificate() { } + /** + * Indicates if expired SSL certificates are accepted. Default value: **false**. + * + * @param acceptsExpiredCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate) { @@ -246,6 +251,11 @@ public Boolean getAcceptsSelfSignedCertificate() { } + /** + * Indicates if self-signed SSL certificates are accepted. Default value: **false**. + * + * @param acceptsSelfSignedCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate) { @@ -271,6 +281,11 @@ public Boolean getAcceptsUntrustedRootCertificate() { } + /** + * Indicates if untrusted SSL certificates are accepted. Default value: **false**. + * + * @param acceptsUntrustedRootCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate) { @@ -296,6 +311,11 @@ public Boolean getActive() { } + /** + * Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -321,6 +341,11 @@ public AdditionalSettings getAdditionalSettings() { } + /** + * additionalSettings + * + * @param additionalSettings + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalSettings(AdditionalSettings additionalSettings) { @@ -346,6 +371,11 @@ public CommunicationFormatEnum getCommunicationFormat() { } + /** + * Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json** + * + * @param communicationFormat + */ @JsonProperty(JSON_PROPERTY_COMMUNICATION_FORMAT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommunicationFormat(CommunicationFormatEnum communicationFormat) { @@ -371,6 +401,11 @@ public String getDescription() { } + /** + * Your description for this webhook configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -396,6 +431,11 @@ public EncryptionProtocolEnum getEncryptionProtocol() { } + /** + * SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**. + * + * @param encryptionProtocol + */ @JsonProperty(JSON_PROPERTY_ENCRYPTION_PROTOCOL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptionProtocol(EncryptionProtocolEnum encryptionProtocol) { @@ -421,6 +461,11 @@ public NetworkTypeEnum getNetworkType() { } + /** + * Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**. + * + * @param networkType + */ @JsonProperty(JSON_PROPERTY_NETWORK_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkType(NetworkTypeEnum networkType) { @@ -446,6 +491,11 @@ public String getPassword() { } + /** + * Password to access the webhook URL. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -471,6 +521,11 @@ public Boolean getPopulateSoapActionHeader() { } + /** + * Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**. + * + * @param populateSoapActionHeader + */ @JsonProperty(JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPopulateSoapActionHeader(Boolean populateSoapActionHeader) { @@ -496,6 +551,11 @@ public String getType() { } + /** + * The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **rreq-notification** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -521,6 +581,11 @@ public String getUrl() { } + /** + * Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -546,6 +611,11 @@ public String getUsername() { } + /** + * Username to access the webhook URL. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/CreateUserResponse.java b/src/main/java/com/adyen/model/management/CreateUserResponse.java index 734d335cb..021a017f3 100644 --- a/src/main/java/com/adyen/model/management/CreateUserResponse.java +++ b/src/main/java/com/adyen/model/management/CreateUserResponse.java @@ -99,6 +99,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -132,6 +137,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -157,6 +167,11 @@ public Boolean getActive() { } + /** + * Indicates whether this user is active. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -190,6 +205,11 @@ public List getApps() { } + /** + * Set of apps available to this user + * + * @param apps + */ @JsonProperty(JSON_PROPERTY_APPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApps(List apps) { @@ -215,6 +235,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -240,6 +265,11 @@ public String getId() { } + /** + * The unique identifier of the user. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -265,6 +295,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -295,6 +330,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -320,6 +360,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { @@ -345,6 +390,11 @@ public String getUsername() { } + /** + * The username for this user. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/Currency.java b/src/main/java/com/adyen/model/management/Currency.java index 8b1fa8a18..b8019605f 100644 --- a/src/main/java/com/adyen/model/management/Currency.java +++ b/src/main/java/com/adyen/model/management/Currency.java @@ -67,6 +67,11 @@ public Integer getAmount() { } + /** + * Surcharge amount per transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Integer amount) { @@ -92,6 +97,11 @@ public String getCurrencyCode() { } + /** + * Three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, **AUD**. + * + * @param currencyCode + */ @JsonProperty(JSON_PROPERTY_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyCode(String currencyCode) { @@ -117,6 +127,11 @@ public Double getPercentage() { } + /** + * Surcharge percentage per transaction. The maximum number of decimal places is two. For example, **1%** or **2.27%**. + * + * @param percentage + */ @JsonProperty(JSON_PROPERTY_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPercentage(Double percentage) { diff --git a/src/main/java/com/adyen/model/management/CustomNotification.java b/src/main/java/com/adyen/model/management/CustomNotification.java index 0fc8d8249..940881429 100644 --- a/src/main/java/com/adyen/model/management/CustomNotification.java +++ b/src/main/java/com/adyen/model/management/CustomNotification.java @@ -85,6 +85,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -110,6 +115,11 @@ public String getEventCode() { } + /** + * The event that caused the notification to be sent.Currently supported values: * **AUTHORISATION** * **CANCELLATION** * **REFUND** * **CAPTURE** * **REPORT_AVAILABLE** * **CHARGEBACK** * **REQUEST_FOR_INFORMATION** * **NOTIFICATION_OF_CHARGEBACK** * **NOTIFICATIONTEST** * **ORDER_OPENED** * **ORDER_CLOSED** * **CHARGEBACK_REVERSED** * **REFUNDED_REVERSED** * **REFUND_WITH_DATA** + * + * @param eventCode + */ @JsonProperty(JSON_PROPERTY_EVENT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEventCode(String eventCode) { @@ -135,6 +145,11 @@ public OffsetDateTime getEventDate() { } + /** + * The time of the event. Format: [ISO 8601](http://www.w3.org/TR/NOTE-datetime), YYYY-MM-DDThh:mm:ssTZD. + * + * @param eventDate + */ @JsonProperty(JSON_PROPERTY_EVENT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEventDate(OffsetDateTime eventDate) { @@ -160,6 +175,11 @@ public String getMerchantReference() { } + /** + * Your reference for the custom test notification. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -185,6 +205,11 @@ public String getPaymentMethod() { } + /** + * The payment method for the payment that the notification is about. Possible values: * **amex** * **visa** * **mc** * **maestro** * **bcmc** * **paypal** * **sms** * **bankTransfer_NL** * **bankTransfer_DE** * **bankTransfer_BE** * **ideal** * **elv** * **sepadirectdebit** + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -210,6 +235,11 @@ public String getReason() { } + /** + * A descripton of what caused the notification. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(String reason) { @@ -235,6 +265,11 @@ public Boolean getSuccess() { } + /** + * The outcome of the event which the notification is about. Set to either **true** or **false**. + * + * @param success + */ @JsonProperty(JSON_PROPERTY_SUCCESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSuccess(Boolean success) { diff --git a/src/main/java/com/adyen/model/management/DataCenter.java b/src/main/java/com/adyen/model/management/DataCenter.java index 57cb3c37d..283b9fd69 100644 --- a/src/main/java/com/adyen/model/management/DataCenter.java +++ b/src/main/java/com/adyen/model/management/DataCenter.java @@ -63,6 +63,11 @@ public String getLivePrefix() { } + /** + * The unique [live URL prefix](https://docs.adyen.com/development-resources/live-endpoints#live-url-prefix) for your live endpoint. Each data center has its own live URL prefix. This field is empty for requests made in the test environment. + * + * @param livePrefix + */ @JsonProperty(JSON_PROPERTY_LIVE_PREFIX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLivePrefix(String livePrefix) { @@ -88,6 +93,11 @@ public String getName() { } + /** + * The name assigned to a data center, for example **EU** for the European data center. Possible values are: * **default**: the European data center. This value is always returned in the test environment. * **AU** * **EU** * **US** + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/management/EventUrl.java b/src/main/java/com/adyen/model/management/EventUrl.java index 6b105d43c..76d543ffc 100644 --- a/src/main/java/com/adyen/model/management/EventUrl.java +++ b/src/main/java/com/adyen/model/management/EventUrl.java @@ -74,6 +74,11 @@ public List getEventLocalUrls() { } + /** + * One or more local URLs to send event notifications to when using Terminal API. + * + * @param eventLocalUrls + */ @JsonProperty(JSON_PROPERTY_EVENT_LOCAL_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEventLocalUrls(List eventLocalUrls) { @@ -107,6 +112,11 @@ public List getEventPublicUrls() { } + /** + * One or more public URLs to send event notifications to when using Terminal API. + * + * @param eventPublicUrls + */ @JsonProperty(JSON_PROPERTY_EVENT_PUBLIC_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEventPublicUrls(List eventPublicUrls) { diff --git a/src/main/java/com/adyen/model/management/ExternalTerminalAction.java b/src/main/java/com/adyen/model/management/ExternalTerminalAction.java index 607c8aa5c..2e72f4862 100644 --- a/src/main/java/com/adyen/model/management/ExternalTerminalAction.java +++ b/src/main/java/com/adyen/model/management/ExternalTerminalAction.java @@ -88,6 +88,11 @@ public String getActionType() { } + /** + * The type of terminal action: **InstallAndroidApp**, **UninstallAndroidApp**, **InstallAndroidCertificate**, or **UninstallAndroidCertificate**. + * + * @param actionType + */ @JsonProperty(JSON_PROPERTY_ACTION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActionType(String actionType) { @@ -113,6 +118,11 @@ public String getConfig() { } + /** + * Technical information about the terminal action. + * + * @param config + */ @JsonProperty(JSON_PROPERTY_CONFIG) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfig(String config) { @@ -138,6 +148,11 @@ public OffsetDateTime getConfirmedAt() { } + /** + * The date and time when the action was carried out. + * + * @param confirmedAt + */ @JsonProperty(JSON_PROPERTY_CONFIRMED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfirmedAt(OffsetDateTime confirmedAt) { @@ -163,6 +178,11 @@ public String getId() { } + /** + * The unique ID of the terminal action. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -188,6 +208,11 @@ public String getResult() { } + /** + * The result message for the action. + * + * @param result + */ @JsonProperty(JSON_PROPERTY_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResult(String result) { @@ -213,6 +238,11 @@ public OffsetDateTime getScheduledAt() { } + /** + * The date and time when the action was scheduled to happen. + * + * @param scheduledAt + */ @JsonProperty(JSON_PROPERTY_SCHEDULED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScheduledAt(OffsetDateTime scheduledAt) { @@ -238,6 +268,11 @@ public String getStatus() { } + /** + * The status of the terminal action: **pending**, **successful**, **failed**, **cancelled**, or **tryLater**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { @@ -263,6 +298,11 @@ public String getTerminalId() { } + /** + * The unique ID of the terminal that the action applies to. + * + * @param terminalId + */ @JsonProperty(JSON_PROPERTY_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalId(String terminalId) { diff --git a/src/main/java/com/adyen/model/management/GenerateApiKeyResponse.java b/src/main/java/com/adyen/model/management/GenerateApiKeyResponse.java index a4bd3ca3b..ee9c3a69b 100644 --- a/src/main/java/com/adyen/model/management/GenerateApiKeyResponse.java +++ b/src/main/java/com/adyen/model/management/GenerateApiKeyResponse.java @@ -59,6 +59,11 @@ public String getApiKey() { } + /** + * The generated API key. + * + * @param apiKey + */ @JsonProperty(JSON_PROPERTY_API_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiKey(String apiKey) { diff --git a/src/main/java/com/adyen/model/management/GenerateClientKeyResponse.java b/src/main/java/com/adyen/model/management/GenerateClientKeyResponse.java index ea90fae18..4add43b76 100644 --- a/src/main/java/com/adyen/model/management/GenerateClientKeyResponse.java +++ b/src/main/java/com/adyen/model/management/GenerateClientKeyResponse.java @@ -59,6 +59,11 @@ public String getClientKey() { } + /** + * Generated client key + * + * @param clientKey + */ @JsonProperty(JSON_PROPERTY_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientKey(String clientKey) { diff --git a/src/main/java/com/adyen/model/management/GenerateHmacKeyResponse.java b/src/main/java/com/adyen/model/management/GenerateHmacKeyResponse.java index aa5532c4b..cbe76293e 100644 --- a/src/main/java/com/adyen/model/management/GenerateHmacKeyResponse.java +++ b/src/main/java/com/adyen/model/management/GenerateHmacKeyResponse.java @@ -59,6 +59,11 @@ public String getHmacKey() { } + /** + * The HMAC key generated for this webhook. + * + * @param hmacKey + */ @JsonProperty(JSON_PROPERTY_HMAC_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHmacKey(String hmacKey) { diff --git a/src/main/java/com/adyen/model/management/GenericPmWithTdiInfo.java b/src/main/java/com/adyen/model/management/GenericPmWithTdiInfo.java index 2d5389653..3a3718efb 100644 --- a/src/main/java/com/adyen/model/management/GenericPmWithTdiInfo.java +++ b/src/main/java/com/adyen/model/management/GenericPmWithTdiInfo.java @@ -60,6 +60,11 @@ public TransactionDescriptionInfo getTransactionDescription() { } + /** + * transactionDescription + * + * @param transactionDescription + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionDescription(TransactionDescriptionInfo transactionDescription) { diff --git a/src/main/java/com/adyen/model/management/GiroPayInfo.java b/src/main/java/com/adyen/model/management/GiroPayInfo.java index 5fcf6729e..3a9b7225f 100644 --- a/src/main/java/com/adyen/model/management/GiroPayInfo.java +++ b/src/main/java/com/adyen/model/management/GiroPayInfo.java @@ -59,6 +59,11 @@ public String getSupportEmail() { } + /** + * The email address of merchant support. + * + * @param supportEmail + */ @JsonProperty(JSON_PROPERTY_SUPPORT_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportEmail(String supportEmail) { diff --git a/src/main/java/com/adyen/model/management/GooglePayInfo.java b/src/main/java/com/adyen/model/management/GooglePayInfo.java index bf293a4d9..30e9aaa91 100644 --- a/src/main/java/com/adyen/model/management/GooglePayInfo.java +++ b/src/main/java/com/adyen/model/management/GooglePayInfo.java @@ -63,6 +63,11 @@ public String getMerchantId() { } + /** + * Google Pay [Merchant ID](https://support.google.com/paymentscenter/answer/7163092?hl=en). Character length and limitations: 16 alphanumeric characters or 20 numeric characters. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -88,6 +93,11 @@ public Boolean getReuseMerchantId() { } + /** + * Indicates whether the Google Pay Merchant ID is used for several merchant accounts. Default value: **false**. + * + * @param reuseMerchantId + */ @JsonProperty(JSON_PROPERTY_REUSE_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReuseMerchantId(Boolean reuseMerchantId) { diff --git a/src/main/java/com/adyen/model/management/Gratuity.java b/src/main/java/com/adyen/model/management/Gratuity.java index d7fbd6bcf..23a5a9f97 100644 --- a/src/main/java/com/adyen/model/management/Gratuity.java +++ b/src/main/java/com/adyen/model/management/Gratuity.java @@ -73,6 +73,11 @@ public Boolean getAllowCustomAmount() { } + /** + * Indicates whether one of the predefined tipping options is to let the shopper enter a custom tip. If **true**, only three of the other options defined in `predefinedTipEntries` are shown. + * + * @param allowCustomAmount + */ @JsonProperty(JSON_PROPERTY_ALLOW_CUSTOM_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowCustomAmount(Boolean allowCustomAmount) { @@ -98,6 +103,11 @@ public String getCurrency() { } + /** + * The currency that the tipping settings apply to. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -131,6 +141,11 @@ public List getPredefinedTipEntries() { } + /** + * Tipping options the shopper can choose from if `usePredefinedTipEntries` is **true**. The maximum number of predefined options is four, or three plus the option to enter a custom tip. The options can be a mix of: - A percentage of the transaction amount. Example: **5%** - A tip amount in [minor units](https://docs.adyen.com/development-resources/currency-codes). Example: **500** for a EUR 5 tip. + * + * @param predefinedTipEntries + */ @JsonProperty(JSON_PROPERTY_PREDEFINED_TIP_ENTRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPredefinedTipEntries(List predefinedTipEntries) { @@ -156,6 +171,11 @@ public Boolean getUsePredefinedTipEntries() { } + /** + * Indicates whether the terminal shows a prompt to enter a tip (**false**), or predefined tipping options to choose from (**true**). + * + * @param usePredefinedTipEntries + */ @JsonProperty(JSON_PROPERTY_USE_PREDEFINED_TIP_ENTRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsePredefinedTipEntries(Boolean usePredefinedTipEntries) { diff --git a/src/main/java/com/adyen/model/management/Hardware.java b/src/main/java/com/adyen/model/management/Hardware.java index 7e96d908d..04bf3184a 100644 --- a/src/main/java/com/adyen/model/management/Hardware.java +++ b/src/main/java/com/adyen/model/management/Hardware.java @@ -32,6 +32,7 @@ */ @JsonPropertyOrder({ Hardware.JSON_PROPERTY_DISPLAY_MAXIMUM_BACK_LIGHT, + Hardware.JSON_PROPERTY_RESET_TOTALS_HOUR, Hardware.JSON_PROPERTY_RESTART_HOUR }) @@ -39,6 +40,9 @@ public class Hardware { public static final String JSON_PROPERTY_DISPLAY_MAXIMUM_BACK_LIGHT = "displayMaximumBackLight"; private Integer displayMaximumBackLight; + public static final String JSON_PROPERTY_RESET_TOTALS_HOUR = "resetTotalsHour"; + private Integer resetTotalsHour; + public static final String JSON_PROPERTY_RESTART_HOUR = "restartHour"; private Integer restartHour; @@ -63,6 +67,11 @@ public Integer getDisplayMaximumBackLight() { } + /** + * The brightness of the display when the terminal is being used, expressed as a percentage. + * + * @param displayMaximumBackLight + */ @JsonProperty(JSON_PROPERTY_DISPLAY_MAXIMUM_BACK_LIGHT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisplayMaximumBackLight(Integer displayMaximumBackLight) { @@ -70,16 +79,46 @@ public void setDisplayMaximumBackLight(Integer displayMaximumBackLight) { } + public Hardware resetTotalsHour(Integer resetTotalsHour) { + this.resetTotalsHour = resetTotalsHour; + return this; + } + + /** + * The hour of the day when the terminal is set to reset the Totals report. By default, the reset hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23. + * @return resetTotalsHour + **/ + @ApiModelProperty(value = "The hour of the day when the terminal is set to reset the Totals report. By default, the reset hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.") + @JsonProperty(JSON_PROPERTY_RESET_TOTALS_HOUR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Integer getResetTotalsHour() { + return resetTotalsHour; + } + + + /** + * The hour of the day when the terminal is set to reset the Totals report. By default, the reset hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23. + * + * @param resetTotalsHour + */ + @JsonProperty(JSON_PROPERTY_RESET_TOTALS_HOUR) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setResetTotalsHour(Integer resetTotalsHour) { + this.resetTotalsHour = resetTotalsHour; + } + + public Hardware restartHour(Integer restartHour) { this.restartHour = restartHour; return this; } /** - * The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal Minimum vaoue: 0, maximum value: 23. + * The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23. * @return restartHour **/ - @ApiModelProperty(value = "The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal Minimum vaoue: 0, maximum value: 23.") + @ApiModelProperty(value = "The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23.") @JsonProperty(JSON_PROPERTY_RESTART_HOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -88,6 +127,11 @@ public Integer getRestartHour() { } + /** + * The hour of the day when the terminal is set to reboot to apply the configuration and software updates. By default, the restart hour is at 6:00 AM in the timezone of the terminal. Minimum value: 0, maximum value: 23. + * + * @param restartHour + */ @JsonProperty(JSON_PROPERTY_RESTART_HOUR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRestartHour(Integer restartHour) { @@ -108,12 +152,13 @@ public boolean equals(Object o) { } Hardware hardware = (Hardware) o; return Objects.equals(this.displayMaximumBackLight, hardware.displayMaximumBackLight) && + Objects.equals(this.resetTotalsHour, hardware.resetTotalsHour) && Objects.equals(this.restartHour, hardware.restartHour); } @Override public int hashCode() { - return Objects.hash(displayMaximumBackLight, restartHour); + return Objects.hash(displayMaximumBackLight, resetTotalsHour, restartHour); } @Override @@ -121,6 +166,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Hardware {\n"); sb.append(" displayMaximumBackLight: ").append(toIndentedString(displayMaximumBackLight)).append("\n"); + sb.append(" resetTotalsHour: ").append(toIndentedString(resetTotalsHour)).append("\n"); sb.append(" restartHour: ").append(toIndentedString(restartHour)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/com/adyen/model/management/IdName.java b/src/main/java/com/adyen/model/management/IdName.java index 29a3dace9..53203466d 100644 --- a/src/main/java/com/adyen/model/management/IdName.java +++ b/src/main/java/com/adyen/model/management/IdName.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * The identifier of the terminal model. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getName() { } + /** + * The name of the terminal model. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/management/InstallAndroidAppDetails.java b/src/main/java/com/adyen/model/management/InstallAndroidAppDetails.java index f070ab779..ae5615135 100644 --- a/src/main/java/com/adyen/model/management/InstallAndroidAppDetails.java +++ b/src/main/java/com/adyen/model/management/InstallAndroidAppDetails.java @@ -96,6 +96,11 @@ public String getAppId() { } + /** + * The unique identifier of the app to be installed. + * + * @param appId + */ @JsonProperty(JSON_PROPERTY_APP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAppId(String appId) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * Type of terminal action: Install an Android app. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/management/InstallAndroidCertificateDetails.java b/src/main/java/com/adyen/model/management/InstallAndroidCertificateDetails.java index 39ce3583b..9801636cb 100644 --- a/src/main/java/com/adyen/model/management/InstallAndroidCertificateDetails.java +++ b/src/main/java/com/adyen/model/management/InstallAndroidCertificateDetails.java @@ -96,6 +96,11 @@ public String getCertificateId() { } + /** + * The unique identifier of the certificate to be installed. + * + * @param certificateId + */ @JsonProperty(JSON_PROPERTY_CERTIFICATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCertificateId(String certificateId) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * Type of terminal action: Install an Android certificate. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/management/InvalidField.java b/src/main/java/com/adyen/model/management/InvalidField.java index 7f3a9174c..56f92edb2 100644 --- a/src/main/java/com/adyen/model/management/InvalidField.java +++ b/src/main/java/com/adyen/model/management/InvalidField.java @@ -67,6 +67,11 @@ public String getMessage() { } + /** + * Description of the validation error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -92,6 +97,11 @@ public String getName() { } + /** + * The field that has an invalid value. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -117,6 +127,11 @@ public String getValue() { } + /** + * The invalid value. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(String value) { diff --git a/src/main/java/com/adyen/model/management/Key.java b/src/main/java/com/adyen/model/management/Key.java index 01a82e515..8047b7087 100644 --- a/src/main/java/com/adyen/model/management/Key.java +++ b/src/main/java/com/adyen/model/management/Key.java @@ -67,6 +67,11 @@ public String getIdentifier() { } + /** + * The unique identifier of the shared key. + * + * @param identifier + */ @JsonProperty(JSON_PROPERTY_IDENTIFIER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdentifier(String identifier) { @@ -92,6 +97,11 @@ public String getPassphrase() { } + /** + * The secure passphrase to protect the shared key. + * + * @param passphrase + */ @JsonProperty(JSON_PROPERTY_PASSPHRASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassphrase(String passphrase) { @@ -117,6 +127,11 @@ public Integer getVersion() { } + /** + * The version number of the shared key. + * + * @param version + */ @JsonProperty(JSON_PROPERTY_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersion(Integer version) { diff --git a/src/main/java/com/adyen/model/management/KlarnaInfo.java b/src/main/java/com/adyen/model/management/KlarnaInfo.java index 19b03b68a..622466a70 100644 --- a/src/main/java/com/adyen/model/management/KlarnaInfo.java +++ b/src/main/java/com/adyen/model/management/KlarnaInfo.java @@ -110,6 +110,11 @@ public Boolean getAutoCapture() { } + /** + * Indicates the status of [Automatic capture](https://docs.adyen.com/online-payments/capture#automatic-capture). Default value: **false**. + * + * @param autoCapture + */ @JsonProperty(JSON_PROPERTY_AUTO_CAPTURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAutoCapture(Boolean autoCapture) { @@ -135,6 +140,11 @@ public String getDisputeEmail() { } + /** + * The email address for disputes. + * + * @param disputeEmail + */ @JsonProperty(JSON_PROPERTY_DISPUTE_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisputeEmail(String disputeEmail) { @@ -160,6 +170,11 @@ public RegionEnum getRegion() { } + /** + * The region of operation. For example, **NA**, **EU**, **CH**, **AU**. + * + * @param region + */ @JsonProperty(JSON_PROPERTY_REGION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRegion(RegionEnum region) { @@ -185,6 +200,11 @@ public String getSupportEmail() { } + /** + * The email address of merchant support. + * + * @param supportEmail + */ @JsonProperty(JSON_PROPERTY_SUPPORT_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSupportEmail(String supportEmail) { diff --git a/src/main/java/com/adyen/model/management/Links.java b/src/main/java/com/adyen/model/management/Links.java index a50fa0916..d207c3b6d 100644 --- a/src/main/java/com/adyen/model/management/Links.java +++ b/src/main/java/com/adyen/model/management/Links.java @@ -60,6 +60,11 @@ public LinksElement getSelf() { } + /** + * self + * + * @param self + */ @JsonProperty(JSON_PROPERTY_SELF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelf(LinksElement self) { diff --git a/src/main/java/com/adyen/model/management/LinksElement.java b/src/main/java/com/adyen/model/management/LinksElement.java index ebf4fd205..9a046b090 100644 --- a/src/main/java/com/adyen/model/management/LinksElement.java +++ b/src/main/java/com/adyen/model/management/LinksElement.java @@ -59,6 +59,11 @@ public String getHref() { } + /** + * href + * + * @param href + */ @JsonProperty(JSON_PROPERTY_HREF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHref(String href) { diff --git a/src/main/java/com/adyen/model/management/ListCompanyApiCredentialsResponse.java b/src/main/java/com/adyen/model/management/ListCompanyApiCredentialsResponse.java index ebe7928b1..90d340d66 100644 --- a/src/main/java/com/adyen/model/management/ListCompanyApiCredentialsResponse.java +++ b/src/main/java/com/adyen/model/management/ListCompanyApiCredentialsResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of API credentials. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListCompanyResponse.java b/src/main/java/com/adyen/model/management/ListCompanyResponse.java index f512b73e3..5bddab77d 100644 --- a/src/main/java/com/adyen/model/management/ListCompanyResponse.java +++ b/src/main/java/com/adyen/model/management/ListCompanyResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of companies. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListCompanyUsersResponse.java b/src/main/java/com/adyen/model/management/ListCompanyUsersResponse.java index 7a161510e..7b57f863d 100644 --- a/src/main/java/com/adyen/model/management/ListCompanyUsersResponse.java +++ b/src/main/java/com/adyen/model/management/ListCompanyUsersResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of users. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListExternalTerminalActionsResponse.java b/src/main/java/com/adyen/model/management/ListExternalTerminalActionsResponse.java index 0346475b8..812e8a082 100644 --- a/src/main/java/com/adyen/model/management/ListExternalTerminalActionsResponse.java +++ b/src/main/java/com/adyen/model/management/ListExternalTerminalActionsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * The list of terminal actions. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/ListMerchantApiCredentialsResponse.java b/src/main/java/com/adyen/model/management/ListMerchantApiCredentialsResponse.java index 211fec165..d0ed8a375 100644 --- a/src/main/java/com/adyen/model/management/ListMerchantApiCredentialsResponse.java +++ b/src/main/java/com/adyen/model/management/ListMerchantApiCredentialsResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of API credentials. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListMerchantResponse.java b/src/main/java/com/adyen/model/management/ListMerchantResponse.java index a8334d4bb..270a98fde 100644 --- a/src/main/java/com/adyen/model/management/ListMerchantResponse.java +++ b/src/main/java/com/adyen/model/management/ListMerchantResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of merchant accounts. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListMerchantUsersResponse.java b/src/main/java/com/adyen/model/management/ListMerchantUsersResponse.java index 7447db0af..b970537d9 100644 --- a/src/main/java/com/adyen/model/management/ListMerchantUsersResponse.java +++ b/src/main/java/com/adyen/model/management/ListMerchantUsersResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of users. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListStoresResponse.java b/src/main/java/com/adyen/model/management/ListStoresResponse.java index c01a54347..c6926f932 100644 --- a/src/main/java/com/adyen/model/management/ListStoresResponse.java +++ b/src/main/java/com/adyen/model/management/ListStoresResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * List of stores + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListTerminalsResponse.java b/src/main/java/com/adyen/model/management/ListTerminalsResponse.java index 993472a18..1c97e4853 100644 --- a/src/main/java/com/adyen/model/management/ListTerminalsResponse.java +++ b/src/main/java/com/adyen/model/management/ListTerminalsResponse.java @@ -75,6 +75,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -108,6 +113,11 @@ public List getData() { } + /** + * The list of terminals and their details. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -133,6 +143,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -158,6 +173,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/ListWebhooksResponse.java b/src/main/java/com/adyen/model/management/ListWebhooksResponse.java index 9e6500542..a2f928ba9 100644 --- a/src/main/java/com/adyen/model/management/ListWebhooksResponse.java +++ b/src/main/java/com/adyen/model/management/ListWebhooksResponse.java @@ -79,6 +79,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -104,6 +109,11 @@ public String getAccountReference() { } + /** + * Reference to the account. + * + * @param accountReference + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountReference(String accountReference) { @@ -137,6 +147,11 @@ public List getData() { } + /** + * The list of webhooks configured for this account. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -162,6 +177,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -187,6 +207,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { diff --git a/src/main/java/com/adyen/model/management/Localization.java b/src/main/java/com/adyen/model/management/Localization.java index 82c334181..45828ec07 100644 --- a/src/main/java/com/adyen/model/management/Localization.java +++ b/src/main/java/com/adyen/model/management/Localization.java @@ -31,13 +31,17 @@ * Localization */ @JsonPropertyOrder({ - Localization.JSON_PROPERTY_LANGUAGE + Localization.JSON_PROPERTY_LANGUAGE, + Localization.JSON_PROPERTY_SECONDARY_LANGUAGE }) public class Localization { public static final String JSON_PROPERTY_LANGUAGE = "language"; private String language; + public static final String JSON_PROPERTY_SECONDARY_LANGUAGE = "secondaryLanguage"; + private String secondaryLanguage; + public Localization() { } @@ -59,6 +63,11 @@ public String getLanguage() { } + /** + * Language of the terminal. + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -66,6 +75,36 @@ public void setLanguage(String language) { } + public Localization secondaryLanguage(String secondaryLanguage) { + this.secondaryLanguage = secondaryLanguage; + return this; + } + + /** + * Secondary language of the terminal. + * @return secondaryLanguage + **/ + @ApiModelProperty(value = "Secondary language of the terminal.") + @JsonProperty(JSON_PROPERTY_SECONDARY_LANGUAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSecondaryLanguage() { + return secondaryLanguage; + } + + + /** + * Secondary language of the terminal. + * + * @param secondaryLanguage + */ + @JsonProperty(JSON_PROPERTY_SECONDARY_LANGUAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSecondaryLanguage(String secondaryLanguage) { + this.secondaryLanguage = secondaryLanguage; + } + + /** * Return true if this Localization object is equal to o. */ @@ -78,12 +117,13 @@ public boolean equals(Object o) { return false; } Localization localization = (Localization) o; - return Objects.equals(this.language, localization.language); + return Objects.equals(this.language, localization.language) && + Objects.equals(this.secondaryLanguage, localization.secondaryLanguage); } @Override public int hashCode() { - return Objects.hash(language); + return Objects.hash(language, secondaryLanguage); } @Override @@ -91,6 +131,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class Localization {\n"); sb.append(" language: ").append(toIndentedString(language)).append("\n"); + sb.append(" secondaryLanguage: ").append(toIndentedString(secondaryLanguage)).append("\n"); sb.append("}"); return sb.toString(); } diff --git a/src/main/java/com/adyen/model/management/Logo.java b/src/main/java/com/adyen/model/management/Logo.java index a63373f99..6e0d9feca 100644 --- a/src/main/java/com/adyen/model/management/Logo.java +++ b/src/main/java/com/adyen/model/management/Logo.java @@ -59,6 +59,11 @@ public String getData() { } + /** + * The image file, converted to a Base64-encoded string, of the logo to be shown on the terminal. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(String data) { diff --git a/src/main/java/com/adyen/model/management/MeApiCredential.java b/src/main/java/com/adyen/model/management/MeApiCredential.java index de3007e78..b1d9b7170 100644 --- a/src/main/java/com/adyen/model/management/MeApiCredential.java +++ b/src/main/java/com/adyen/model/management/MeApiCredential.java @@ -103,6 +103,11 @@ public ApiCredentialLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(ApiCredentialLinks links) { @@ -128,6 +133,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -158,6 +168,11 @@ public List getAllowedIpAddresses() { } + /** + * List of IP addresses from which your client can make requests. If the list is empty, we allow requests from any IP. If the list is not empty and we get a request from an IP which is not on the list, you get a security error. + * + * @param allowedIpAddresses + */ @JsonProperty(JSON_PROPERTY_ALLOWED_IP_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedIpAddresses(List allowedIpAddresses) { @@ -191,6 +206,11 @@ public List getAllowedOrigins() { } + /** + * List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -224,6 +244,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * List of merchant accounts that the API credential has explicit access to. If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -249,6 +274,11 @@ public String getClientKey() { } + /** + * Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations. + * + * @param clientKey + */ @JsonProperty(JSON_PROPERTY_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClientKey(String clientKey) { @@ -274,6 +304,11 @@ public String getCompanyName() { } + /** + * Name of the company linked to the API credential. + * + * @param companyName + */ @JsonProperty(JSON_PROPERTY_COMPANY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyName(String companyName) { @@ -299,6 +334,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -324,6 +364,11 @@ public String getId() { } + /** + * Unique identifier of the API credential. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -354,6 +399,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -379,6 +429,11 @@ public String getUsername() { } + /** + * The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/MealVoucherFRInfo.java b/src/main/java/com/adyen/model/management/MealVoucherFRInfo.java index 550fc1d4b..d1cf790f8 100644 --- a/src/main/java/com/adyen/model/management/MealVoucherFRInfo.java +++ b/src/main/java/com/adyen/model/management/MealVoucherFRInfo.java @@ -69,6 +69,11 @@ public String getConecsId() { } + /** + * Meal Voucher conecsId. Format: digits only + * + * @param conecsId + */ @JsonProperty(JSON_PROPERTY_CONECS_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConecsId(String conecsId) { @@ -94,6 +99,11 @@ public String getSiret() { } + /** + * Meal Voucher siret. Format: 14 digits. + * + * @param siret + */ @JsonProperty(JSON_PROPERTY_SIRET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSiret(String siret) { @@ -124,6 +134,11 @@ public List getSubTypes() { } + /** + * The list of additional payment methods. Allowed values: **mealVoucher_FR_edenred**, **mealVoucher_FR_groupeup**, **mealVoucher_FR_natixis**, **mealVoucher_FR_sodexo**. + * + * @param subTypes + */ @JsonProperty(JSON_PROPERTY_SUB_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubTypes(List subTypes) { diff --git a/src/main/java/com/adyen/model/management/Merchant.java b/src/main/java/com/adyen/model/management/Merchant.java index 266c94b35..e23482740 100644 --- a/src/main/java/com/adyen/model/management/Merchant.java +++ b/src/main/java/com/adyen/model/management/Merchant.java @@ -115,6 +115,11 @@ public MerchantLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(MerchantLinks links) { @@ -140,6 +145,11 @@ public String getCaptureDelay() { } + /** + * The [capture delay](https://docs.adyen.com/online-payments/capture#capture-delay) set for the merchant account. Possible values: * **Immediate** * **Manual** * Number of days from **1** to **29** + * + * @param captureDelay + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelay(String captureDelay) { @@ -165,6 +175,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account this merchant belongs to + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -198,6 +213,11 @@ public List getDataCenters() { } + /** + * List of available data centers. Adyen has several data centers around the world.In the URL that you use for making API requests, we recommend you use the live URL prefix from the data center closest to your shoppers. + * + * @param dataCenters + */ @JsonProperty(JSON_PROPERTY_DATA_CENTERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDataCenters(List dataCenters) { @@ -223,6 +243,11 @@ public String getDefaultShopperInteraction() { } + /** + * The default [`shopperInteraction`](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/post/payments__reqParam_shopperInteraction) value used when processing payments through this merchant account. + * + * @param defaultShopperInteraction + */ @JsonProperty(JSON_PROPERTY_DEFAULT_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultShopperInteraction(String defaultShopperInteraction) { @@ -248,6 +273,11 @@ public String getDescription() { } + /** + * Your description for the merchant account, maximum 300 characters + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -273,6 +303,11 @@ public String getId() { } + /** + * The unique identifier of the merchant account. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -298,6 +333,11 @@ public String getMerchantCity() { } + /** + * The city where the legal entity of this merchant account is registered. + * + * @param merchantCity + */ @JsonProperty(JSON_PROPERTY_MERCHANT_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantCity(String merchantCity) { @@ -323,6 +363,11 @@ public String getName() { } + /** + * The name of the legal entity associated with the merchant account. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -348,6 +393,11 @@ public String getPricingPlan() { } + /** + * Only applies to merchant accounts managed by Adyen's partners. The name of the pricing plan assigned to the merchant account. + * + * @param pricingPlan + */ @JsonProperty(JSON_PROPERTY_PRICING_PLAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPricingPlan(String pricingPlan) { @@ -373,6 +423,11 @@ public String getPrimarySettlementCurrency() { } + /** + * The currency of the country where the legal entity of this merchant account is registered. Format: [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). For example, a legal entity based in the United States has USD as the primary settlement currency. + * + * @param primarySettlementCurrency + */ @JsonProperty(JSON_PROPERTY_PRIMARY_SETTLEMENT_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrimarySettlementCurrency(String primarySettlementCurrency) { @@ -398,6 +453,11 @@ public String getReference() { } + /** + * Reference of the merchant account. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -423,6 +483,11 @@ public String getShopWebAddress() { } + /** + * The URL for the ecommerce website used with this merchant account. + * + * @param shopWebAddress + */ @JsonProperty(JSON_PROPERTY_SHOP_WEB_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopWebAddress(String shopWebAddress) { @@ -448,6 +513,11 @@ public String getStatus() { } + /** + * The status of the merchant account. Possible values: * **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments. * **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled. * **InactiveWithModifications**: Users can access the merchant account in the Customer Area. You cannot process new payments but you can still modify payments, for example issue refunds. You can still receive payouts. * **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled. * **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/management/MerchantLinks.java b/src/main/java/com/adyen/model/management/MerchantLinks.java index 2241ac6a6..85dbd5d2c 100644 --- a/src/main/java/com/adyen/model/management/MerchantLinks.java +++ b/src/main/java/com/adyen/model/management/MerchantLinks.java @@ -72,6 +72,11 @@ public LinksElement getApiCredentials() { } + /** + * apiCredentials + * + * @param apiCredentials + */ @JsonProperty(JSON_PROPERTY_API_CREDENTIALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApiCredentials(LinksElement apiCredentials) { @@ -97,6 +102,11 @@ public LinksElement getSelf() { } + /** + * self + * + * @param self + */ @JsonProperty(JSON_PROPERTY_SELF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelf(LinksElement self) { @@ -122,6 +132,11 @@ public LinksElement getUsers() { } + /** + * users + * + * @param users + */ @JsonProperty(JSON_PROPERTY_USERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsers(LinksElement users) { @@ -147,6 +162,11 @@ public LinksElement getWebhooks() { } + /** + * webhooks + * + * @param webhooks + */ @JsonProperty(JSON_PROPERTY_WEBHOOKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWebhooks(LinksElement webhooks) { diff --git a/src/main/java/com/adyen/model/management/MinorUnitsMonetaryValue.java b/src/main/java/com/adyen/model/management/MinorUnitsMonetaryValue.java index 2812ef46e..bec9e016e 100644 --- a/src/main/java/com/adyen/model/management/MinorUnitsMonetaryValue.java +++ b/src/main/java/com/adyen/model/management/MinorUnitsMonetaryValue.java @@ -63,6 +63,11 @@ public Integer getAmount() { } + /** + * The transaction amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Integer amount) { @@ -88,6 +93,11 @@ public String getCurrencyCode() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currencyCode + */ @JsonProperty(JSON_PROPERTY_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyCode(String currencyCode) { diff --git a/src/main/java/com/adyen/model/management/ModelConfiguration.java b/src/main/java/com/adyen/model/management/ModelConfiguration.java index 02eb4d044..e16e4b3b1 100644 --- a/src/main/java/com/adyen/model/management/ModelConfiguration.java +++ b/src/main/java/com/adyen/model/management/ModelConfiguration.java @@ -75,6 +75,11 @@ public String getBrand() { } + /** + * Payment method, like **eftpos_australia** or **mc**. See the [possible values](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). + * + * @param brand + */ @JsonProperty(JSON_PROPERTY_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrand(String brand) { @@ -108,6 +113,11 @@ public List getCountry() { } + /** + * Countries, to filter different surcharge amounts for domestic or international cards. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(List country) { @@ -138,6 +148,11 @@ public List getCurrencies() { } + /** + * Currency, and surcharge percentage or amount. + * + * @param currencies + */ @JsonProperty(JSON_PROPERTY_CURRENCIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencies(List currencies) { @@ -171,6 +186,11 @@ public List getSources() { } + /** + * Funding source. Possible values: * **Credit** * **Debit** + * + * @param sources + */ @JsonProperty(JSON_PROPERTY_SOURCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSources(List sources) { diff --git a/src/main/java/com/adyen/model/management/ModelFile.java b/src/main/java/com/adyen/model/management/ModelFile.java index ff9de054e..bd8d40174 100644 --- a/src/main/java/com/adyen/model/management/ModelFile.java +++ b/src/main/java/com/adyen/model/management/ModelFile.java @@ -64,6 +64,11 @@ public String getData() { } + /** + * The certificate content converted to a Base64-encoded string. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(String data) { @@ -89,6 +94,11 @@ public String getName() { } + /** + * The name of the certificate. Must be unique across Wi-Fi profiles. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/management/Name.java b/src/main/java/com/adyen/model/management/Name.java index bd5e0e66f..060583879 100644 --- a/src/main/java/com/adyen/model/management/Name.java +++ b/src/main/java/com/adyen/model/management/Name.java @@ -63,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -88,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/management/Name2.java b/src/main/java/com/adyen/model/management/Name2.java index 5d377b849..fd9774f4c 100644 --- a/src/main/java/com/adyen/model/management/Name2.java +++ b/src/main/java/com/adyen/model/management/Name2.java @@ -63,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -88,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/management/Nexo.java b/src/main/java/com/adyen/model/management/Nexo.java index 5b8504261..ac1c5b6b6 100644 --- a/src/main/java/com/adyen/model/management/Nexo.java +++ b/src/main/java/com/adyen/model/management/Nexo.java @@ -81,6 +81,11 @@ public NotificationUrl getDisplayUrls() { } + /** + * displayUrls + * + * @param displayUrls + */ @JsonProperty(JSON_PROPERTY_DISPLAY_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisplayUrls(NotificationUrl displayUrls) { @@ -106,6 +111,11 @@ public Key getEncryptionKey() { } + /** + * encryptionKey + * + * @param encryptionKey + */ @JsonProperty(JSON_PROPERTY_ENCRYPTION_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptionKey(Key encryptionKey) { @@ -131,6 +141,11 @@ public EventUrl getEventUrls() { } + /** + * eventUrls + * + * @param eventUrls + */ @JsonProperty(JSON_PROPERTY_EVENT_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEventUrls(EventUrl eventUrls) { @@ -166,6 +181,11 @@ public List getNexoEventUrls() { } + /** + * One or more URLs to send event messages to when using Terminal API. + * + * @param nexoEventUrls + */ @Deprecated @JsonProperty(JSON_PROPERTY_NEXO_EVENT_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -192,6 +212,11 @@ public Notification getNotification() { } + /** + * notification + * + * @param notification + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotification(Notification notification) { diff --git a/src/main/java/com/adyen/model/management/Notification.java b/src/main/java/com/adyen/model/management/Notification.java index a31e1cbb9..11e71cfad 100644 --- a/src/main/java/com/adyen/model/management/Notification.java +++ b/src/main/java/com/adyen/model/management/Notification.java @@ -59,6 +59,11 @@ public Boolean getShowButton() { } + /** + * Shows or hides the event notification button on the terminal screen. + * + * @param showButton + */ @JsonProperty(JSON_PROPERTY_SHOW_BUTTON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShowButton(Boolean showButton) { diff --git a/src/main/java/com/adyen/model/management/NotificationUrl.java b/src/main/java/com/adyen/model/management/NotificationUrl.java index 2b8a4dc26..51ca23ab6 100644 --- a/src/main/java/com/adyen/model/management/NotificationUrl.java +++ b/src/main/java/com/adyen/model/management/NotificationUrl.java @@ -74,6 +74,11 @@ public List getLocalUrls() { } + /** + * One or more local URLs to send notifications to when using Terminal API. + * + * @param localUrls + */ @JsonProperty(JSON_PROPERTY_LOCAL_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalUrls(List localUrls) { @@ -107,6 +112,11 @@ public List getPublicUrls() { } + /** + * One or more public URLs to send notifications to when using Terminal API. + * + * @param publicUrls + */ @JsonProperty(JSON_PROPERTY_PUBLIC_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPublicUrls(List publicUrls) { diff --git a/src/main/java/com/adyen/model/management/OfflineProcessing.java b/src/main/java/com/adyen/model/management/OfflineProcessing.java index 5ac0a1236..cb4824262 100644 --- a/src/main/java/com/adyen/model/management/OfflineProcessing.java +++ b/src/main/java/com/adyen/model/management/OfflineProcessing.java @@ -66,6 +66,11 @@ public Integer getChipFloorLimit() { } + /** + * The maximum offline transaction amount for chip cards, in the processing currency and specified in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param chipFloorLimit + */ @JsonProperty(JSON_PROPERTY_CHIP_FLOOR_LIMIT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChipFloorLimit(Integer chipFloorLimit) { @@ -99,6 +104,11 @@ public List getOfflineSwipeLimits() { } + /** + * The maximum offline transaction amount for swiped cards, in the specified currency. + * + * @param offlineSwipeLimits + */ @JsonProperty(JSON_PROPERTY_OFFLINE_SWIPE_LIMITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOfflineSwipeLimits(List offlineSwipeLimits) { diff --git a/src/main/java/com/adyen/model/management/Opi.java b/src/main/java/com/adyen/model/management/Opi.java index 9ad8fb3f0..93d009fe7 100644 --- a/src/main/java/com/adyen/model/management/Opi.java +++ b/src/main/java/com/adyen/model/management/Opi.java @@ -67,6 +67,11 @@ public Boolean getEnablePayAtTable() { } + /** + * Indicates if Pay at table is enabled. + * + * @param enablePayAtTable + */ @JsonProperty(JSON_PROPERTY_ENABLE_PAY_AT_TABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnablePayAtTable(Boolean enablePayAtTable) { @@ -92,6 +97,11 @@ public String getPayAtTableStoreNumber() { } + /** + * The store number to use for Pay at Table. + * + * @param payAtTableStoreNumber + */ @JsonProperty(JSON_PROPERTY_PAY_AT_TABLE_STORE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayAtTableStoreNumber(String payAtTableStoreNumber) { @@ -117,6 +127,11 @@ public String getPayAtTableURL() { } + /** + * The URL and port number used for Pay at Table communication. + * + * @param payAtTableURL + */ @JsonProperty(JSON_PROPERTY_PAY_AT_TABLE_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayAtTableURL(String payAtTableURL) { diff --git a/src/main/java/com/adyen/model/management/OrderItem.java b/src/main/java/com/adyen/model/management/OrderItem.java index 0c3744c1b..0dff3fc66 100644 --- a/src/main/java/com/adyen/model/management/OrderItem.java +++ b/src/main/java/com/adyen/model/management/OrderItem.java @@ -71,6 +71,11 @@ public String getId() { } + /** + * The unique identifier of the product. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -96,6 +101,11 @@ public Long getInstallments() { } + /** + * The number of installments for the specified product `id`. + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Long installments) { @@ -121,6 +131,11 @@ public String getName() { } + /** + * The name of the product. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -146,6 +161,11 @@ public Integer getQuantity() { } + /** + * The number of items with the specified product `id` included in the order. + * + * @param quantity + */ @JsonProperty(JSON_PROPERTY_QUANTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQuantity(Integer quantity) { diff --git a/src/main/java/com/adyen/model/management/PaginationLinks.java b/src/main/java/com/adyen/model/management/PaginationLinks.java index 5793c8615..f140b5337 100644 --- a/src/main/java/com/adyen/model/management/PaginationLinks.java +++ b/src/main/java/com/adyen/model/management/PaginationLinks.java @@ -76,6 +76,11 @@ public LinksElement getFirst() { } + /** + * first + * + * @param first + */ @JsonProperty(JSON_PROPERTY_FIRST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirst(LinksElement first) { @@ -101,6 +106,11 @@ public LinksElement getLast() { } + /** + * last + * + * @param last + */ @JsonProperty(JSON_PROPERTY_LAST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLast(LinksElement last) { @@ -126,6 +136,11 @@ public LinksElement getNext() { } + /** + * next + * + * @param next + */ @JsonProperty(JSON_PROPERTY_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNext(LinksElement next) { @@ -151,6 +166,11 @@ public LinksElement getPrev() { } + /** + * prev + * + * @param prev + */ @JsonProperty(JSON_PROPERTY_PREV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrev(LinksElement prev) { @@ -176,6 +196,11 @@ public LinksElement getSelf() { } + /** + * self + * + * @param self + */ @JsonProperty(JSON_PROPERTY_SELF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelf(LinksElement self) { diff --git a/src/main/java/com/adyen/model/management/Passcodes.java b/src/main/java/com/adyen/model/management/Passcodes.java index 70de906c3..68db90558 100644 --- a/src/main/java/com/adyen/model/management/Passcodes.java +++ b/src/main/java/com/adyen/model/management/Passcodes.java @@ -71,6 +71,11 @@ public String getAdminMenuPin() { } + /** + * The passcode for the Admin menu and the Settings menu. + * + * @param adminMenuPin + */ @JsonProperty(JSON_PROPERTY_ADMIN_MENU_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdminMenuPin(String adminMenuPin) { @@ -96,6 +101,11 @@ public String getRefundPin() { } + /** + * The passcode for unreferenced refunds on standalone terminals. + * + * @param refundPin + */ @JsonProperty(JSON_PROPERTY_REFUND_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefundPin(String refundPin) { @@ -121,6 +131,11 @@ public String getScreenLockPin() { } + /** + * The passcode to unlock the terminal screen after a timeout. + * + * @param screenLockPin + */ @JsonProperty(JSON_PROPERTY_SCREEN_LOCK_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScreenLockPin(String screenLockPin) { @@ -146,6 +161,11 @@ public String getTxMenuPin() { } + /** + * The passcode for the Transactions menu. + * + * @param txMenuPin + */ @JsonProperty(JSON_PROPERTY_TX_MENU_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxMenuPin(String txMenuPin) { diff --git a/src/main/java/com/adyen/model/management/PayAtTable.java b/src/main/java/com/adyen/model/management/PayAtTable.java index fc11ef0fc..656dab350 100644 --- a/src/main/java/com/adyen/model/management/PayAtTable.java +++ b/src/main/java/com/adyen/model/management/PayAtTable.java @@ -98,6 +98,11 @@ public AuthenticationMethodEnum getAuthenticationMethod() { } + /** + * Allowed authentication methods: Magswipe, Manual Entry. + * + * @param authenticationMethod + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationMethod(AuthenticationMethodEnum authenticationMethod) { @@ -123,6 +128,11 @@ public Boolean getEnablePayAtTable() { } + /** + * Enable Pay at table. + * + * @param enablePayAtTable + */ @JsonProperty(JSON_PROPERTY_ENABLE_PAY_AT_TABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnablePayAtTable(Boolean enablePayAtTable) { diff --git a/src/main/java/com/adyen/model/management/PayPalInfo.java b/src/main/java/com/adyen/model/management/PayPalInfo.java index c691a9aad..960a1c842 100644 --- a/src/main/java/com/adyen/model/management/PayPalInfo.java +++ b/src/main/java/com/adyen/model/management/PayPalInfo.java @@ -67,6 +67,11 @@ public Boolean getDirectCapture() { } + /** + * Indicates if direct (immediate) capture for PayPal is enabled. If set to **true**, this setting overrides the [capture](https://docs.adyen.com/online-payments/capture) settings of your merchant account. Default value: **true**. + * + * @param directCapture + */ @JsonProperty(JSON_PROPERTY_DIRECT_CAPTURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectCapture(Boolean directCapture) { @@ -92,6 +97,11 @@ public String getPayerId() { } + /** + * PayPal Merchant ID. Character length and limitations: 13 single-byte alphanumeric characters. + * + * @param payerId + */ @JsonProperty(JSON_PROPERTY_PAYER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayerId(String payerId) { @@ -117,6 +127,11 @@ public String getSubject() { } + /** + * Your business email address. + * + * @param subject + */ @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubject(String subject) { diff --git a/src/main/java/com/adyen/model/management/Payment.java b/src/main/java/com/adyen/model/management/Payment.java index f7926a0c9..528da7e43 100644 --- a/src/main/java/com/adyen/model/management/Payment.java +++ b/src/main/java/com/adyen/model/management/Payment.java @@ -65,6 +65,11 @@ public String getContactlessCurrency() { } + /** + * The default currency for contactless payments on the payment terminal, as the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. + * + * @param contactlessCurrency + */ @JsonProperty(JSON_PROPERTY_CONTACTLESS_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContactlessCurrency(String contactlessCurrency) { @@ -98,6 +103,11 @@ public List getHideMinorUnitsInCurrencies() { } + /** + * Hides the minor units for the listed [ISO currency codes](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param hideMinorUnitsInCurrencies + */ @JsonProperty(JSON_PROPERTY_HIDE_MINOR_UNITS_IN_CURRENCIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHideMinorUnitsInCurrencies(List hideMinorUnitsInCurrencies) { diff --git a/src/main/java/com/adyen/model/management/PaymentMethod.java b/src/main/java/com/adyen/model/management/PaymentMethod.java index 751d5a203..044834265 100644 --- a/src/main/java/com/adyen/model/management/PaymentMethod.java +++ b/src/main/java/com/adyen/model/management/PaymentMethod.java @@ -259,6 +259,11 @@ public AfterpayTouchInfo getAfterpayTouch() { } + /** + * afterpayTouch + * + * @param afterpayTouch + */ @JsonProperty(JSON_PROPERTY_AFTERPAY_TOUCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAfterpayTouch(AfterpayTouchInfo afterpayTouch) { @@ -284,6 +289,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -309,6 +319,11 @@ public ApplePayInfo getApplePay() { } + /** + * applePay + * + * @param applePay + */ @JsonProperty(JSON_PROPERTY_APPLE_PAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplePay(ApplePayInfo applePay) { @@ -334,6 +349,11 @@ public BcmcInfo getBcmc() { } + /** + * bcmc + * + * @param bcmc + */ @JsonProperty(JSON_PROPERTY_BCMC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBcmc(BcmcInfo bcmc) { @@ -359,6 +379,11 @@ public String getBusinessLineId() { } + /** + * The unique identifier of the business line. + * + * @param businessLineId + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineId(String businessLineId) { @@ -384,6 +409,11 @@ public CartesBancairesInfo getCartesBancaires() { } + /** + * cartesBancaires + * + * @param cartesBancaires + */ @JsonProperty(JSON_PROPERTY_CARTES_BANCAIRES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCartesBancaires(CartesBancairesInfo cartesBancaires) { @@ -409,6 +439,11 @@ public ClearpayInfo getClearpay() { } + /** + * clearpay + * + * @param clearpay + */ @JsonProperty(JSON_PROPERTY_CLEARPAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearpay(ClearpayInfo clearpay) { @@ -442,6 +477,11 @@ public List getCountries() { } + /** + * The list of countries where a payment method is available. By default, all countries supported by the payment method. + * + * @param countries + */ @JsonProperty(JSON_PROPERTY_COUNTRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountries(List countries) { @@ -467,6 +507,11 @@ public GenericPmWithTdiInfo getCup() { } + /** + * cup + * + * @param cup + */ @JsonProperty(JSON_PROPERTY_CUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCup(GenericPmWithTdiInfo cup) { @@ -500,6 +545,11 @@ public List getCurrencies() { } + /** + * The list of currencies that a payment method supports. By default, all currencies supported by the payment method. + * + * @param currencies + */ @JsonProperty(JSON_PROPERTY_CURRENCIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencies(List currencies) { @@ -533,6 +583,11 @@ public List getCustomRoutingFlags() { } + /** + * The list of custom routing flags to route payment to the intended acquirer. + * + * @param customRoutingFlags + */ @JsonProperty(JSON_PROPERTY_CUSTOM_ROUTING_FLAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomRoutingFlags(List customRoutingFlags) { @@ -558,6 +613,11 @@ public GenericPmWithTdiInfo getDiners() { } + /** + * diners + * + * @param diners + */ @JsonProperty(JSON_PROPERTY_DINERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiners(GenericPmWithTdiInfo diners) { @@ -583,6 +643,11 @@ public GenericPmWithTdiInfo getDiscover() { } + /** + * discover + * + * @param discover + */ @JsonProperty(JSON_PROPERTY_DISCOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiscover(GenericPmWithTdiInfo discover) { @@ -608,6 +673,11 @@ public GenericPmWithTdiInfo getEftposAustralia() { } + /** + * eftposAustralia + * + * @param eftposAustralia + */ @JsonProperty(JSON_PROPERTY_EFTPOS_AUSTRALIA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEftposAustralia(GenericPmWithTdiInfo eftposAustralia) { @@ -633,6 +703,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the payment method is enabled (**true**) or disabled (**false**). + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -658,6 +733,11 @@ public GiroPayInfo getGiroPay() { } + /** + * giroPay + * + * @param giroPay + */ @JsonProperty(JSON_PROPERTY_GIRO_PAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiroPay(GiroPayInfo giroPay) { @@ -683,6 +763,11 @@ public GenericPmWithTdiInfo getGirocard() { } + /** + * girocard + * + * @param girocard + */ @JsonProperty(JSON_PROPERTY_GIROCARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGirocard(GenericPmWithTdiInfo girocard) { @@ -708,6 +793,11 @@ public GooglePayInfo getGooglePay() { } + /** + * googlePay + * + * @param googlePay + */ @JsonProperty(JSON_PROPERTY_GOOGLE_PAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGooglePay(GooglePayInfo googlePay) { @@ -733,6 +823,11 @@ public String getId() { } + /** + * The identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -758,6 +853,11 @@ public GenericPmWithTdiInfo getIdeal() { } + /** + * ideal + * + * @param ideal + */ @JsonProperty(JSON_PROPERTY_IDEAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdeal(GenericPmWithTdiInfo ideal) { @@ -783,6 +883,11 @@ public GenericPmWithTdiInfo getInteracCard() { } + /** + * interacCard + * + * @param interacCard + */ @JsonProperty(JSON_PROPERTY_INTERAC_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInteracCard(GenericPmWithTdiInfo interacCard) { @@ -808,6 +913,11 @@ public GenericPmWithTdiInfo getJcb() { } + /** + * jcb + * + * @param jcb + */ @JsonProperty(JSON_PROPERTY_JCB) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJcb(GenericPmWithTdiInfo jcb) { @@ -833,6 +943,11 @@ public KlarnaInfo getKlarna() { } + /** + * klarna + * + * @param klarna + */ @JsonProperty(JSON_PROPERTY_KLARNA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setKlarna(KlarnaInfo klarna) { @@ -858,6 +973,11 @@ public GenericPmWithTdiInfo getMaestro() { } + /** + * maestro + * + * @param maestro + */ @JsonProperty(JSON_PROPERTY_MAESTRO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaestro(GenericPmWithTdiInfo maestro) { @@ -883,6 +1003,11 @@ public GenericPmWithTdiInfo getMc() { } + /** + * mc + * + * @param mc + */ @JsonProperty(JSON_PROPERTY_MC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMc(GenericPmWithTdiInfo mc) { @@ -908,6 +1033,11 @@ public MealVoucherFRInfo getMealVoucherFR() { } + /** + * mealVoucherFR + * + * @param mealVoucherFR + */ @JsonProperty(JSON_PROPERTY_MEAL_VOUCHER_F_R) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMealVoucherFR(MealVoucherFRInfo mealVoucherFR) { @@ -933,6 +1063,11 @@ public PayPalInfo getPaypal() { } + /** + * paypal + * + * @param paypal + */ @JsonProperty(JSON_PROPERTY_PAYPAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaypal(PayPalInfo paypal) { @@ -958,6 +1093,11 @@ public String getReference() { } + /** + * Your reference for the payment method. Supported characters a-z, A-Z, 0-9. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -983,6 +1123,11 @@ public String getShopperInteraction() { } + /** + * The sales channel. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(String shopperInteraction) { @@ -1008,6 +1153,11 @@ public SofortInfo getSofort() { } + /** + * sofort + * + * @param sofort + */ @JsonProperty(JSON_PROPERTY_SOFORT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSofort(SofortInfo sofort) { @@ -1041,6 +1191,11 @@ public List getStoreIds() { } + /** + * The unique identifier of the store for which to configure the payment method, if any. + * + * @param storeIds + */ @JsonProperty(JSON_PROPERTY_STORE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreIds(List storeIds) { @@ -1066,6 +1221,11 @@ public SwishInfo getSwish() { } + /** + * swish + * + * @param swish + */ @JsonProperty(JSON_PROPERTY_SWISH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSwish(SwishInfo swish) { @@ -1091,6 +1251,11 @@ public TwintInfo getTwint() { } + /** + * twint + * + * @param twint + */ @JsonProperty(JSON_PROPERTY_TWINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTwint(TwintInfo twint) { @@ -1116,6 +1281,11 @@ public String getType() { } + /** + * Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -1141,6 +1311,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * Payment method status. Possible values: * **valid** * **pending** * **invalid** * **rejected** + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { @@ -1166,6 +1341,11 @@ public VippsInfo getVipps() { } + /** + * vipps + * + * @param vipps + */ @JsonProperty(JSON_PROPERTY_VIPPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVipps(VippsInfo vipps) { @@ -1191,6 +1371,11 @@ public GenericPmWithTdiInfo getVisa() { } + /** + * visa + * + * @param visa + */ @JsonProperty(JSON_PROPERTY_VISA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisa(GenericPmWithTdiInfo visa) { diff --git a/src/main/java/com/adyen/model/management/PaymentMethodResponse.java b/src/main/java/com/adyen/model/management/PaymentMethodResponse.java index 57118ffed..24f6427a3 100644 --- a/src/main/java/com/adyen/model/management/PaymentMethodResponse.java +++ b/src/main/java/com/adyen/model/management/PaymentMethodResponse.java @@ -208,6 +208,11 @@ public PaginationLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(PaginationLinks links) { @@ -241,6 +246,11 @@ public List getData() { } + /** + * The list of supported payment methods and their details. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { @@ -266,6 +276,11 @@ public Integer getItemsTotal() { } + /** + * Total number of items. + * + * @param itemsTotal + */ @JsonProperty(JSON_PROPERTY_ITEMS_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsTotal(Integer itemsTotal) { @@ -291,6 +306,11 @@ public Integer getPagesTotal() { } + /** + * Total number of pages. + * + * @param pagesTotal + */ @JsonProperty(JSON_PROPERTY_PAGES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPagesTotal(Integer pagesTotal) { @@ -324,6 +344,11 @@ public List getTypesWithErrors() { } + /** + * Payment method types with errors. + * + * @param typesWithErrors + */ @JsonProperty(JSON_PROPERTY_TYPES_WITH_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTypesWithErrors(List typesWithErrors) { diff --git a/src/main/java/com/adyen/model/management/PaymentMethodSetupInfo.java b/src/main/java/com/adyen/model/management/PaymentMethodSetupInfo.java index 24ef538e4..70c176d8f 100644 --- a/src/main/java/com/adyen/model/management/PaymentMethodSetupInfo.java +++ b/src/main/java/com/adyen/model/management/PaymentMethodSetupInfo.java @@ -372,6 +372,11 @@ public AfterpayTouchInfo getAfterpayTouch() { } + /** + * afterpayTouch + * + * @param afterpayTouch + */ @JsonProperty(JSON_PROPERTY_AFTERPAY_TOUCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAfterpayTouch(AfterpayTouchInfo afterpayTouch) { @@ -397,6 +402,11 @@ public ApplePayInfo getApplePay() { } + /** + * applePay + * + * @param applePay + */ @JsonProperty(JSON_PROPERTY_APPLE_PAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplePay(ApplePayInfo applePay) { @@ -422,6 +432,11 @@ public BcmcInfo getBcmc() { } + /** + * bcmc + * + * @param bcmc + */ @JsonProperty(JSON_PROPERTY_BCMC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBcmc(BcmcInfo bcmc) { @@ -447,6 +462,11 @@ public String getBusinessLineId() { } + /** + * The unique identifier of the business line. + * + * @param businessLineId + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineId(String businessLineId) { @@ -472,6 +492,11 @@ public CartesBancairesInfo getCartesBancaires() { } + /** + * cartesBancaires + * + * @param cartesBancaires + */ @JsonProperty(JSON_PROPERTY_CARTES_BANCAIRES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCartesBancaires(CartesBancairesInfo cartesBancaires) { @@ -497,6 +522,11 @@ public ClearpayInfo getClearpay() { } + /** + * clearpay + * + * @param clearpay + */ @JsonProperty(JSON_PROPERTY_CLEARPAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearpay(ClearpayInfo clearpay) { @@ -530,6 +560,11 @@ public List getCountries() { } + /** + * The list of countries where a payment method is available. By default, all countries supported by the payment method. + * + * @param countries + */ @JsonProperty(JSON_PROPERTY_COUNTRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountries(List countries) { @@ -555,6 +590,11 @@ public GenericPmWithTdiInfo getCup() { } + /** + * cup + * + * @param cup + */ @JsonProperty(JSON_PROPERTY_CUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCup(GenericPmWithTdiInfo cup) { @@ -588,6 +628,11 @@ public List getCurrencies() { } + /** + * The list of currencies that a payment method supports. By default, all currencies supported by the payment method. + * + * @param currencies + */ @JsonProperty(JSON_PROPERTY_CURRENCIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencies(List currencies) { @@ -621,6 +666,11 @@ public List getCustomRoutingFlags() { } + /** + * The list of custom routing flags to route payment to the intended acquirer. + * + * @param customRoutingFlags + */ @JsonProperty(JSON_PROPERTY_CUSTOM_ROUTING_FLAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomRoutingFlags(List customRoutingFlags) { @@ -646,6 +696,11 @@ public GenericPmWithTdiInfo getDiners() { } + /** + * diners + * + * @param diners + */ @JsonProperty(JSON_PROPERTY_DINERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiners(GenericPmWithTdiInfo diners) { @@ -671,6 +726,11 @@ public GenericPmWithTdiInfo getDiscover() { } + /** + * discover + * + * @param discover + */ @JsonProperty(JSON_PROPERTY_DISCOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiscover(GenericPmWithTdiInfo discover) { @@ -696,6 +756,11 @@ public GenericPmWithTdiInfo getEftposAustralia() { } + /** + * eftposAustralia + * + * @param eftposAustralia + */ @JsonProperty(JSON_PROPERTY_EFTPOS_AUSTRALIA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEftposAustralia(GenericPmWithTdiInfo eftposAustralia) { @@ -721,6 +786,11 @@ public GiroPayInfo getGiroPay() { } + /** + * giroPay + * + * @param giroPay + */ @JsonProperty(JSON_PROPERTY_GIRO_PAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiroPay(GiroPayInfo giroPay) { @@ -746,6 +816,11 @@ public GenericPmWithTdiInfo getGirocard() { } + /** + * girocard + * + * @param girocard + */ @JsonProperty(JSON_PROPERTY_GIROCARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGirocard(GenericPmWithTdiInfo girocard) { @@ -771,6 +846,11 @@ public GooglePayInfo getGooglePay() { } + /** + * googlePay + * + * @param googlePay + */ @JsonProperty(JSON_PROPERTY_GOOGLE_PAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGooglePay(GooglePayInfo googlePay) { @@ -796,6 +876,11 @@ public GenericPmWithTdiInfo getIdeal() { } + /** + * ideal + * + * @param ideal + */ @JsonProperty(JSON_PROPERTY_IDEAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdeal(GenericPmWithTdiInfo ideal) { @@ -821,6 +906,11 @@ public GenericPmWithTdiInfo getInteracCard() { } + /** + * interacCard + * + * @param interacCard + */ @JsonProperty(JSON_PROPERTY_INTERAC_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInteracCard(GenericPmWithTdiInfo interacCard) { @@ -846,6 +936,11 @@ public GenericPmWithTdiInfo getJcb() { } + /** + * jcb + * + * @param jcb + */ @JsonProperty(JSON_PROPERTY_JCB) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJcb(GenericPmWithTdiInfo jcb) { @@ -871,6 +966,11 @@ public KlarnaInfo getKlarna() { } + /** + * klarna + * + * @param klarna + */ @JsonProperty(JSON_PROPERTY_KLARNA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setKlarna(KlarnaInfo klarna) { @@ -896,6 +996,11 @@ public GenericPmWithTdiInfo getMaestro() { } + /** + * maestro + * + * @param maestro + */ @JsonProperty(JSON_PROPERTY_MAESTRO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaestro(GenericPmWithTdiInfo maestro) { @@ -921,6 +1026,11 @@ public GenericPmWithTdiInfo getMc() { } + /** + * mc + * + * @param mc + */ @JsonProperty(JSON_PROPERTY_MC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMc(GenericPmWithTdiInfo mc) { @@ -946,6 +1056,11 @@ public MealVoucherFRInfo getMealVoucherFR() { } + /** + * mealVoucherFR + * + * @param mealVoucherFR + */ @JsonProperty(JSON_PROPERTY_MEAL_VOUCHER_F_R) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMealVoucherFR(MealVoucherFRInfo mealVoucherFR) { @@ -971,6 +1086,11 @@ public PayPalInfo getPaypal() { } + /** + * paypal + * + * @param paypal + */ @JsonProperty(JSON_PROPERTY_PAYPAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaypal(PayPalInfo paypal) { @@ -996,6 +1116,11 @@ public String getReference() { } + /** + * Your reference for the payment method. Supported characters a-z, A-Z, 0-9. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1021,6 +1146,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account. Possible values: **eCommerce**, **pos**, **contAuth**, and **moto**. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1046,6 +1176,11 @@ public SofortInfo getSofort() { } + /** + * sofort + * + * @param sofort + */ @JsonProperty(JSON_PROPERTY_SOFORT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSofort(SofortInfo sofort) { @@ -1079,6 +1214,11 @@ public List getStoreIds() { } + /** + * The unique identifier of the store for which to configure the payment method, if any. + * + * @param storeIds + */ @JsonProperty(JSON_PROPERTY_STORE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreIds(List storeIds) { @@ -1104,6 +1244,11 @@ public SwishInfo getSwish() { } + /** + * swish + * + * @param swish + */ @JsonProperty(JSON_PROPERTY_SWISH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSwish(SwishInfo swish) { @@ -1129,6 +1274,11 @@ public TwintInfo getTwint() { } + /** + * twint + * + * @param twint + */ @JsonProperty(JSON_PROPERTY_TWINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTwint(TwintInfo twint) { @@ -1154,6 +1304,11 @@ public TypeEnum getType() { } + /** + * Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -1179,6 +1334,11 @@ public VippsInfo getVipps() { } + /** + * vipps + * + * @param vipps + */ @JsonProperty(JSON_PROPERTY_VIPPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVipps(VippsInfo vipps) { @@ -1204,6 +1364,11 @@ public GenericPmWithTdiInfo getVisa() { } + /** + * visa + * + * @param visa + */ @JsonProperty(JSON_PROPERTY_VISA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisa(GenericPmWithTdiInfo visa) { diff --git a/src/main/java/com/adyen/model/management/PayoutSettings.java b/src/main/java/com/adyen/model/management/PayoutSettings.java index 5595cc947..5e26f4557 100644 --- a/src/main/java/com/adyen/model/management/PayoutSettings.java +++ b/src/main/java/com/adyen/model/management/PayoutSettings.java @@ -159,6 +159,11 @@ public Boolean getAllowed() { } + /** + * Indicates if payouts to the bank account are allowed. This value is set automatically based on the status of the verification process. The value is: * **true** if `verificationStatus` is **valid**. * **false** for all other values. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -184,6 +189,11 @@ public Boolean getEnabled() { } + /** + * Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -209,6 +219,11 @@ public String getEnabledFromDate() { } + /** + * The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**. + * + * @param enabledFromDate + */ @JsonProperty(JSON_PROPERTY_ENABLED_FROM_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabledFromDate(String enabledFromDate) { @@ -234,6 +249,11 @@ public String getId() { } + /** + * The unique identifier of the payout setting. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -259,6 +279,11 @@ public PriorityEnum getPriority() { } + /** + * Determines how long it takes for the funds to reach the bank account. Adyen pays out based on the [payout frequency](https://docs.adyen.com/account/getting-paid#payout-frequency). Depending on the currencies and banks involved in transferring the money, it may take up to three days for the payout funds to arrive in the bank account. Possible values: * **first**: same day. * **urgent**: the next day. * **normal**: between 1 and 3 days. + * + * @param priority + */ @JsonProperty(JSON_PROPERTY_PRIORITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriority(PriorityEnum priority) { @@ -284,6 +309,11 @@ public String getTransferInstrumentId() { } + /** + * The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account. + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { @@ -309,6 +339,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * The status of the verification process for the bank account. Possible values: * **valid**: the verification was successful. * **pending**: the verification is in progress. * **invalid**: the information provided is not complete. * **rejected**: there are reasons to refuse working with this entity. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { diff --git a/src/main/java/com/adyen/model/management/PayoutSettingsRequest.java b/src/main/java/com/adyen/model/management/PayoutSettingsRequest.java index 141251845..07c08d914 100644 --- a/src/main/java/com/adyen/model/management/PayoutSettingsRequest.java +++ b/src/main/java/com/adyen/model/management/PayoutSettingsRequest.java @@ -67,6 +67,11 @@ public Boolean getEnabled() { } + /** + * Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -92,6 +97,11 @@ public String getEnabledFromDate() { } + /** + * The date when Adyen starts paying out to this bank account. Format: [ISO 8601](https://www.w3.org/TR/NOTE-datetime), for example, **2019-11-23T12:25:28Z** or **2020-05-27T20:25:28+08:00**. If not specified, the `enabled` field indicates if payouts are enabled for this bank account. If a date is specified and: * `enabled`: **true**, payouts are enabled starting the specified date. * `enabled`: **false**, payouts are disabled until the specified date. On the specified date, `enabled` changes to **true** and this field is reset to **null**. + * + * @param enabledFromDate + */ @JsonProperty(JSON_PROPERTY_ENABLED_FROM_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabledFromDate(String enabledFromDate) { @@ -117,6 +127,11 @@ public String getTransferInstrumentId() { } + /** + * The unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments) that contains the details of the bank account. + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/management/PayoutSettingsResponse.java b/src/main/java/com/adyen/model/management/PayoutSettingsResponse.java index 49520cf1f..0d7ae5a38 100644 --- a/src/main/java/com/adyen/model/management/PayoutSettingsResponse.java +++ b/src/main/java/com/adyen/model/management/PayoutSettingsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * The list of payout accounts. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/Profile.java b/src/main/java/com/adyen/model/management/Profile.java index 592cd68b0..9f1dae24e 100644 --- a/src/main/java/com/adyen/model/management/Profile.java +++ b/src/main/java/com/adyen/model/management/Profile.java @@ -128,6 +128,11 @@ public String getAuthType() { } + /** + * The type of Wi-Fi network. Possible values: **wpa-psk**, **wpa2-psk**, **wpa-eap**, **wpa2-eap**. + * + * @param authType + */ @JsonProperty(JSON_PROPERTY_AUTH_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthType(String authType) { @@ -153,6 +158,11 @@ public Boolean getAutoWifi() { } + /** + * Indicates whether to automatically select the best authentication method available. Does not work on older terminal models. + * + * @param autoWifi + */ @JsonProperty(JSON_PROPERTY_AUTO_WIFI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAutoWifi(Boolean autoWifi) { @@ -178,6 +188,11 @@ public String getBssType() { } + /** + * Use **infra** for infrastructure-based networks. This applies to most networks. Use **adhoc** only if the communication is p2p-based between base stations. + * + * @param bssType + */ @JsonProperty(JSON_PROPERTY_BSS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBssType(String bssType) { @@ -203,6 +218,11 @@ public Integer getChannel() { } + /** + * The channel number of the Wi-Fi network. The recommended setting is **0** for automatic channel selection. + * + * @param channel + */ @JsonProperty(JSON_PROPERTY_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChannel(Integer channel) { @@ -228,6 +248,11 @@ public Boolean getDefaultProfile() { } + /** + * Indicates whether this is your preferred wireless network. If **true**, the terminal will try connecting to this network first. + * + * @param defaultProfile + */ @JsonProperty(JSON_PROPERTY_DEFAULT_PROFILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDefaultProfile(Boolean defaultProfile) { @@ -253,6 +278,11 @@ public String getEap() { } + /** + * For `authType` **wpa-eap** or **wpa2-eap**. Possible values: **tls**, **peap**, **leap**, **fast** + * + * @param eap + */ @JsonProperty(JSON_PROPERTY_EAP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEap(String eap) { @@ -278,6 +308,11 @@ public ModelFile getEapCaCert() { } + /** + * eapCaCert + * + * @param eapCaCert + */ @JsonProperty(JSON_PROPERTY_EAP_CA_CERT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapCaCert(ModelFile eapCaCert) { @@ -303,6 +338,11 @@ public ModelFile getEapClientCert() { } + /** + * eapClientCert + * + * @param eapClientCert + */ @JsonProperty(JSON_PROPERTY_EAP_CLIENT_CERT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapClientCert(ModelFile eapClientCert) { @@ -328,6 +368,11 @@ public ModelFile getEapClientKey() { } + /** + * eapClientKey + * + * @param eapClientKey + */ @JsonProperty(JSON_PROPERTY_EAP_CLIENT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapClientKey(ModelFile eapClientKey) { @@ -353,6 +398,11 @@ public String getEapClientPwd() { } + /** + * For `eap` **tls**. The password of the RSA key file, if that file is password-protected. + * + * @param eapClientPwd + */ @JsonProperty(JSON_PROPERTY_EAP_CLIENT_PWD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapClientPwd(String eapClientPwd) { @@ -378,6 +428,11 @@ public String getEapIdentity() { } + /** + * For `authType` **wpa-eap** or **wpa2-eap**. The EAP-PEAP username from your MS-CHAP account. Must match the configuration of your RADIUS server. + * + * @param eapIdentity + */ @JsonProperty(JSON_PROPERTY_EAP_IDENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapIdentity(String eapIdentity) { @@ -403,6 +458,11 @@ public ModelFile getEapIntermediateCert() { } + /** + * eapIntermediateCert + * + * @param eapIntermediateCert + */ @JsonProperty(JSON_PROPERTY_EAP_INTERMEDIATE_CERT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapIntermediateCert(ModelFile eapIntermediateCert) { @@ -428,6 +488,11 @@ public String getEapPwd() { } + /** + * For `eap` **peap**. The EAP-PEAP password from your MS-CHAP account. Must match the configuration of your RADIUS server. + * + * @param eapPwd + */ @JsonProperty(JSON_PROPERTY_EAP_PWD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEapPwd(String eapPwd) { @@ -453,6 +518,11 @@ public Boolean getHiddenSsid() { } + /** + * Indicates if the network doesn't broadcast its SSID. Mandatory for Android terminals, because these terminals rely on this setting to be able to connect to any network. + * + * @param hiddenSsid + */ @JsonProperty(JSON_PROPERTY_HIDDEN_SSID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHiddenSsid(Boolean hiddenSsid) { @@ -478,6 +548,11 @@ public String getName() { } + /** + * Your name for the Wi-Fi profile. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -503,6 +578,11 @@ public String getPsk() { } + /** + * For `authType` **wpa-psk or **wpa2-psk**. The password to the wireless network. + * + * @param psk + */ @JsonProperty(JSON_PROPERTY_PSK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPsk(String psk) { @@ -528,6 +608,11 @@ public String getSsid() { } + /** + * The name of the wireless network. + * + * @param ssid + */ @JsonProperty(JSON_PROPERTY_SSID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSsid(String ssid) { @@ -553,6 +638,11 @@ public String getWsec() { } + /** + * The type of encryption. Possible values: **auto**, **ccmp** (recommended), **tkip** + * + * @param wsec + */ @JsonProperty(JSON_PROPERTY_WSEC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWsec(String wsec) { diff --git a/src/main/java/com/adyen/model/management/ReceiptOptions.java b/src/main/java/com/adyen/model/management/ReceiptOptions.java index 7a34ee83a..8f875df3c 100644 --- a/src/main/java/com/adyen/model/management/ReceiptOptions.java +++ b/src/main/java/com/adyen/model/management/ReceiptOptions.java @@ -32,6 +32,7 @@ */ @JsonPropertyOrder({ ReceiptOptions.JSON_PROPERTY_LOGO, + ReceiptOptions.JSON_PROPERTY_PROMPT_BEFORE_PRINTING, ReceiptOptions.JSON_PROPERTY_QR_CODE_DATA }) @@ -39,6 +40,9 @@ public class ReceiptOptions { public static final String JSON_PROPERTY_LOGO = "logo"; private String logo; + public static final String JSON_PROPERTY_PROMPT_BEFORE_PRINTING = "promptBeforePrinting"; + private Boolean promptBeforePrinting; + public static final String JSON_PROPERTY_QR_CODE_DATA = "qrCodeData"; private String qrCodeData; @@ -63,6 +67,11 @@ public String getLogo() { } + /** + * The receipt logo converted to a Base64-encoded string. The image must be a .bmp file of < 256 KB, dimensions 240 (H) x 384 (W) px. + * + * @param logo + */ @JsonProperty(JSON_PROPERTY_LOGO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLogo(String logo) { @@ -70,6 +79,36 @@ public void setLogo(String logo) { } + public ReceiptOptions promptBeforePrinting(Boolean promptBeforePrinting) { + this.promptBeforePrinting = promptBeforePrinting; + return this; + } + + /** + * Indicates whether a screen appears asking if you want to print the shopper receipt. + * @return promptBeforePrinting + **/ + @ApiModelProperty(value = "Indicates whether a screen appears asking if you want to print the shopper receipt.") + @JsonProperty(JSON_PROPERTY_PROMPT_BEFORE_PRINTING) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getPromptBeforePrinting() { + return promptBeforePrinting; + } + + + /** + * Indicates whether a screen appears asking if you want to print the shopper receipt. + * + * @param promptBeforePrinting + */ + @JsonProperty(JSON_PROPERTY_PROMPT_BEFORE_PRINTING) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPromptBeforePrinting(Boolean promptBeforePrinting) { + this.promptBeforePrinting = promptBeforePrinting; + } + + public ReceiptOptions qrCodeData(String qrCodeData) { this.qrCodeData = qrCodeData; return this; @@ -88,6 +127,11 @@ public String getQrCodeData() { } + /** + * Data to print on the receipt as a QR code. This can include static text and the following variables: - `${merchantreference}`: the merchant reference of the transaction. - `${pspreference}`: the PSP reference of the transaction. For example, **http://www.example.com/order/${pspreference}/${merchantreference}**. + * + * @param qrCodeData + */ @JsonProperty(JSON_PROPERTY_QR_CODE_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setQrCodeData(String qrCodeData) { @@ -108,12 +152,13 @@ public boolean equals(Object o) { } ReceiptOptions receiptOptions = (ReceiptOptions) o; return Objects.equals(this.logo, receiptOptions.logo) && + Objects.equals(this.promptBeforePrinting, receiptOptions.promptBeforePrinting) && Objects.equals(this.qrCodeData, receiptOptions.qrCodeData); } @Override public int hashCode() { - return Objects.hash(logo, qrCodeData); + return Objects.hash(logo, promptBeforePrinting, qrCodeData); } @Override @@ -121,6 +166,7 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class ReceiptOptions {\n"); sb.append(" logo: ").append(toIndentedString(logo)).append("\n"); + sb.append(" promptBeforePrinting: ").append(toIndentedString(promptBeforePrinting)).append("\n"); sb.append(" qrCodeData: ").append(toIndentedString(qrCodeData)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/com/adyen/model/management/ReceiptPrinting.java b/src/main/java/com/adyen/model/management/ReceiptPrinting.java index 555ac7f08..40b8e31d6 100644 --- a/src/main/java/com/adyen/model/management/ReceiptPrinting.java +++ b/src/main/java/com/adyen/model/management/ReceiptPrinting.java @@ -119,6 +119,11 @@ public Boolean getMerchantApproved() { } + /** + * Print a merchant receipt when the payment is approved. + * + * @param merchantApproved + */ @JsonProperty(JSON_PROPERTY_MERCHANT_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantApproved(Boolean merchantApproved) { @@ -144,6 +149,11 @@ public Boolean getMerchantCancelled() { } + /** + * Print a merchant receipt when the transaction is cancelled. + * + * @param merchantCancelled + */ @JsonProperty(JSON_PROPERTY_MERCHANT_CANCELLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantCancelled(Boolean merchantCancelled) { @@ -169,6 +179,11 @@ public Boolean getMerchantCaptureApproved() { } + /** + * Print a merchant receipt when capturing the payment is approved. + * + * @param merchantCaptureApproved + */ @JsonProperty(JSON_PROPERTY_MERCHANT_CAPTURE_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantCaptureApproved(Boolean merchantCaptureApproved) { @@ -194,6 +209,11 @@ public Boolean getMerchantCaptureRefused() { } + /** + * Print a merchant receipt when capturing the payment is refused. + * + * @param merchantCaptureRefused + */ @JsonProperty(JSON_PROPERTY_MERCHANT_CAPTURE_REFUSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantCaptureRefused(Boolean merchantCaptureRefused) { @@ -219,6 +239,11 @@ public Boolean getMerchantRefundApproved() { } + /** + * Print a merchant receipt when the refund is approved. + * + * @param merchantRefundApproved + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFUND_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRefundApproved(Boolean merchantRefundApproved) { @@ -244,6 +269,11 @@ public Boolean getMerchantRefundRefused() { } + /** + * Print a merchant receipt when the refund is refused. + * + * @param merchantRefundRefused + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFUND_REFUSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRefundRefused(Boolean merchantRefundRefused) { @@ -269,6 +299,11 @@ public Boolean getMerchantRefused() { } + /** + * Print a merchant receipt when the payment is refused. + * + * @param merchantRefused + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFUSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRefused(Boolean merchantRefused) { @@ -294,6 +329,11 @@ public Boolean getMerchantVoid() { } + /** + * Print a merchant receipt when a previous transaction is voided. + * + * @param merchantVoid + */ @JsonProperty(JSON_PROPERTY_MERCHANT_VOID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantVoid(Boolean merchantVoid) { @@ -319,6 +359,11 @@ public Boolean getShopperApproved() { } + /** + * Print a shopper receipt when the payment is approved. + * + * @param shopperApproved + */ @JsonProperty(JSON_PROPERTY_SHOPPER_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperApproved(Boolean shopperApproved) { @@ -344,6 +389,11 @@ public Boolean getShopperCancelled() { } + /** + * Print a shopper receipt when the transaction is cancelled. + * + * @param shopperCancelled + */ @JsonProperty(JSON_PROPERTY_SHOPPER_CANCELLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperCancelled(Boolean shopperCancelled) { @@ -369,6 +419,11 @@ public Boolean getShopperCaptureApproved() { } + /** + * Print a shopper receipt when capturing the payment is approved. + * + * @param shopperCaptureApproved + */ @JsonProperty(JSON_PROPERTY_SHOPPER_CAPTURE_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperCaptureApproved(Boolean shopperCaptureApproved) { @@ -394,6 +449,11 @@ public Boolean getShopperCaptureRefused() { } + /** + * Print a shopper receipt when capturing the payment is refused. + * + * @param shopperCaptureRefused + */ @JsonProperty(JSON_PROPERTY_SHOPPER_CAPTURE_REFUSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperCaptureRefused(Boolean shopperCaptureRefused) { @@ -419,6 +479,11 @@ public Boolean getShopperRefundApproved() { } + /** + * Print a shopper receipt when the refund is approved. + * + * @param shopperRefundApproved + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFUND_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperRefundApproved(Boolean shopperRefundApproved) { @@ -444,6 +509,11 @@ public Boolean getShopperRefundRefused() { } + /** + * Print a shopper receipt when the refund is refused. + * + * @param shopperRefundRefused + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFUND_REFUSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperRefundRefused(Boolean shopperRefundRefused) { @@ -469,6 +539,11 @@ public Boolean getShopperRefused() { } + /** + * Print a shopper receipt when the payment is refused. + * + * @param shopperRefused + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFUSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperRefused(Boolean shopperRefused) { @@ -494,6 +569,11 @@ public Boolean getShopperVoid() { } + /** + * Print a shopper receipt when a previous transaction is voided. + * + * @param shopperVoid + */ @JsonProperty(JSON_PROPERTY_SHOPPER_VOID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperVoid(Boolean shopperVoid) { diff --git a/src/main/java/com/adyen/model/management/ReleaseUpdateDetails.java b/src/main/java/com/adyen/model/management/ReleaseUpdateDetails.java index b55b7bc24..0eea5f5ad 100644 --- a/src/main/java/com/adyen/model/management/ReleaseUpdateDetails.java +++ b/src/main/java/com/adyen/model/management/ReleaseUpdateDetails.java @@ -96,6 +96,11 @@ public TypeEnum getType() { } + /** + * Type of terminal action: Update Release. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -121,6 +126,11 @@ public Boolean getUpdateAtFirstMaintenanceCall() { } + /** + * Boolean flag that tells if the terminal should update at the first next maintenance call. If false, terminal will update on its configured reboot time. + * + * @param updateAtFirstMaintenanceCall + */ @JsonProperty(JSON_PROPERTY_UPDATE_AT_FIRST_MAINTENANCE_CALL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpdateAtFirstMaintenanceCall(Boolean updateAtFirstMaintenanceCall) { diff --git a/src/main/java/com/adyen/model/management/RequestActivationResponse.java b/src/main/java/com/adyen/model/management/RequestActivationResponse.java index 1b82dfeda..5bc00d469 100644 --- a/src/main/java/com/adyen/model/management/RequestActivationResponse.java +++ b/src/main/java/com/adyen/model/management/RequestActivationResponse.java @@ -63,6 +63,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -88,6 +93,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account you requested to activate. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { diff --git a/src/main/java/com/adyen/model/management/RestServiceError.java b/src/main/java/com/adyen/model/management/RestServiceError.java index c2d25bd7d..2169556d0 100644 --- a/src/main/java/com/adyen/model/management/RestServiceError.java +++ b/src/main/java/com/adyen/model/management/RestServiceError.java @@ -94,6 +94,11 @@ public String getDetail() { } + /** + * A human-readable explanation specific to this occurrence of the problem. + * + * @param detail + */ @JsonProperty(JSON_PROPERTY_DETAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetail(String detail) { @@ -119,6 +124,11 @@ public String getErrorCode() { } + /** + * A code that identifies the problem type. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -144,6 +154,11 @@ public String getInstance() { } + /** + * A unique URI that identifies the specific occurrence of the problem. + * + * @param instance + */ @JsonProperty(JSON_PROPERTY_INSTANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstance(String instance) { @@ -177,6 +192,11 @@ public List getInvalidFields() { } + /** + * Detailed explanation of each validation error, when applicable. + * + * @param invalidFields + */ @JsonProperty(JSON_PROPERTY_INVALID_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvalidFields(List invalidFields) { @@ -202,6 +222,11 @@ public String getRequestId() { } + /** + * A unique reference for the request, essentially the same as `pspReference`. + * + * @param requestId + */ @JsonProperty(JSON_PROPERTY_REQUEST_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestId(String requestId) { @@ -227,6 +252,11 @@ public Object getResponse() { } + /** + * response + * + * @param response + */ @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponse(Object response) { @@ -252,6 +282,11 @@ public Integer getStatus() { } + /** + * The HTTP status code. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { @@ -277,6 +312,11 @@ public String getTitle() { } + /** + * A short, human-readable summary of the problem type. + * + * @param title + */ @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTitle(String title) { @@ -302,6 +342,11 @@ public String getType() { } + /** + * A URI that identifies the problem type, pointing to human-readable documentation on this problem type. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/management/ScheduleTerminalActionsRequest.java b/src/main/java/com/adyen/model/management/ScheduleTerminalActionsRequest.java index 17271bfd6..cedb0f1aa 100644 --- a/src/main/java/com/adyen/model/management/ScheduleTerminalActionsRequest.java +++ b/src/main/java/com/adyen/model/management/ScheduleTerminalActionsRequest.java @@ -74,6 +74,11 @@ public ScheduleTerminalActionsRequestActionDetails getActionDetails() { } + /** + * actionDetails + * + * @param actionDetails + */ @JsonProperty(JSON_PROPERTY_ACTION_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails) { @@ -99,6 +104,11 @@ public String getScheduledAt() { } + /** + * The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** The action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call. + * + * @param scheduledAt + */ @JsonProperty(JSON_PROPERTY_SCHEDULED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScheduledAt(String scheduledAt) { @@ -124,6 +134,11 @@ public String getStoreId() { } + /** + * The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store. + * + * @param storeId + */ @JsonProperty(JSON_PROPERTY_STORE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreId(String storeId) { @@ -157,6 +172,11 @@ public List getTerminalIds() { } + /** + * A list of unique IDs of the terminals to apply the action to. You can extract the IDs from the [GET `/terminals`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/terminals) response. Maximum length: 100 IDs. + * + * @param terminalIds + */ @JsonProperty(JSON_PROPERTY_TERMINAL_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalIds(List terminalIds) { diff --git a/src/main/java/com/adyen/model/management/ScheduleTerminalActionsResponse.java b/src/main/java/com/adyen/model/management/ScheduleTerminalActionsResponse.java index aa08bd7a3..be1c7e1b3 100644 --- a/src/main/java/com/adyen/model/management/ScheduleTerminalActionsResponse.java +++ b/src/main/java/com/adyen/model/management/ScheduleTerminalActionsResponse.java @@ -89,6 +89,11 @@ public ScheduleTerminalActionsRequestActionDetails getActionDetails() { } + /** + * actionDetails + * + * @param actionDetails + */ @JsonProperty(JSON_PROPERTY_ACTION_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActionDetails(ScheduleTerminalActionsRequestActionDetails actionDetails) { @@ -122,6 +127,11 @@ public List getItems() { } + /** + * A list containing a terminal ID and an action ID for each terminal that the action was scheduled for. + * + * @param items + */ @JsonProperty(JSON_PROPERTY_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItems(List items) { @@ -147,6 +157,11 @@ public String getScheduledAt() { } + /** + * The date and time when the action should happen. Format: [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339), but without the **Z** before the time offset. For example, **2021-11-15T12:16:21+01:00** The action is sent with the first [maintenance call](https://docs.adyen.com/point-of-sale/automating-terminal-management/terminal-actions-api#when-actions-take-effect) after the specified date and time in the time zone of the terminal. An empty value causes the action to be sent as soon as possible: at the next maintenance call. + * + * @param scheduledAt + */ @JsonProperty(JSON_PROPERTY_SCHEDULED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScheduledAt(String scheduledAt) { @@ -172,6 +187,11 @@ public String getStoreId() { } + /** + * The unique ID of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/stores). If present, all terminals in the `terminalIds` list must be assigned to this store. + * + * @param storeId + */ @JsonProperty(JSON_PROPERTY_STORE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreId(String storeId) { @@ -205,6 +225,11 @@ public Map> getTerminalsWithErrors() { } + /** + * The validation errors that occurred in the list of terminals, and for each error the IDs of the terminals that the error applies to. + * + * @param terminalsWithErrors + */ @JsonProperty(JSON_PROPERTY_TERMINALS_WITH_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalsWithErrors(Map> terminalsWithErrors) { @@ -230,6 +255,11 @@ public Integer getTotalErrors() { } + /** + * The number of terminals for which scheduling the action failed. + * + * @param totalErrors + */ @JsonProperty(JSON_PROPERTY_TOTAL_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalErrors(Integer totalErrors) { @@ -255,6 +285,11 @@ public Integer getTotalScheduled() { } + /** + * The number of terminals for which the action was successfully scheduled. This doesn't mean the action has happened yet. + * + * @param totalScheduled + */ @JsonProperty(JSON_PROPERTY_TOTAL_SCHEDULED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalScheduled(Integer totalScheduled) { diff --git a/src/main/java/com/adyen/model/management/Settings.java b/src/main/java/com/adyen/model/management/Settings.java index 973885cb4..c0bd886fe 100644 --- a/src/main/java/com/adyen/model/management/Settings.java +++ b/src/main/java/com/adyen/model/management/Settings.java @@ -67,6 +67,11 @@ public String getBand() { } + /** + * The preferred Wi-Fi band, for use if the terminals support multiple bands. Possible values: All, 2.4GHz, 5GHz. + * + * @param band + */ @JsonProperty(JSON_PROPERTY_BAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBand(String band) { @@ -92,6 +97,11 @@ public Boolean getRoaming() { } + /** + * Indicates whether roaming is enabled on the terminals. + * + * @param roaming + */ @JsonProperty(JSON_PROPERTY_ROAMING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoaming(Boolean roaming) { @@ -117,6 +127,11 @@ public Integer getTimeout() { } + /** + * The connection time-out in seconds. Minimum value: 0. + * + * @param timeout + */ @JsonProperty(JSON_PROPERTY_TIMEOUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeout(Integer timeout) { diff --git a/src/main/java/com/adyen/model/management/ShippingLocation.java b/src/main/java/com/adyen/model/management/ShippingLocation.java index 99396c838..c3099e91c 100644 --- a/src/main/java/com/adyen/model/management/ShippingLocation.java +++ b/src/main/java/com/adyen/model/management/ShippingLocation.java @@ -73,6 +73,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -98,6 +103,11 @@ public Contact getContact() { } + /** + * contact + * + * @param contact + */ @JsonProperty(JSON_PROPERTY_CONTACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContact(Contact contact) { @@ -123,6 +133,11 @@ public String getId() { } + /** + * The unique identifier of the shipping location, for use as `shippingLocationId` when creating an order. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -148,6 +163,11 @@ public String getName() { } + /** + * The unique name of the shipping location. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/management/ShippingLocationsResponse.java b/src/main/java/com/adyen/model/management/ShippingLocationsResponse.java index 1d5fc0ffa..4b854ab2f 100644 --- a/src/main/java/com/adyen/model/management/ShippingLocationsResponse.java +++ b/src/main/java/com/adyen/model/management/ShippingLocationsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * Physical locations where orders can be shipped to. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/Signature.java b/src/main/java/com/adyen/model/management/Signature.java index cc10cc5f1..5e30f1198 100644 --- a/src/main/java/com/adyen/model/management/Signature.java +++ b/src/main/java/com/adyen/model/management/Signature.java @@ -71,6 +71,11 @@ public Boolean getAskSignatureOnScreen() { } + /** + * If `skipSignature` is false, indicates whether the shopper should provide a signature on the display (**true**) or on the merchant receipt (**false**). + * + * @param askSignatureOnScreen + */ @JsonProperty(JSON_PROPERTY_ASK_SIGNATURE_ON_SCREEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAskSignatureOnScreen(Boolean askSignatureOnScreen) { @@ -96,6 +101,11 @@ public String getDeviceName() { } + /** + * Name that identifies the terminal. + * + * @param deviceName + */ @JsonProperty(JSON_PROPERTY_DEVICE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceName(String deviceName) { @@ -121,6 +131,11 @@ public String getDeviceSlogan() { } + /** + * Slogan shown on the start screen of the device. + * + * @param deviceSlogan + */ @JsonProperty(JSON_PROPERTY_DEVICE_SLOGAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceSlogan(String deviceSlogan) { @@ -146,6 +161,11 @@ public Boolean getSkipSignature() { } + /** + * Skip asking for a signature. This is possible because all global card schemes (American Express, Diners, Discover, JCB, MasterCard, VISA, and UnionPay) regard a signature as optional. + * + * @param skipSignature + */ @JsonProperty(JSON_PROPERTY_SKIP_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSkipSignature(Boolean skipSignature) { diff --git a/src/main/java/com/adyen/model/management/SofortInfo.java b/src/main/java/com/adyen/model/management/SofortInfo.java index 2418863ff..8f7ac754d 100644 --- a/src/main/java/com/adyen/model/management/SofortInfo.java +++ b/src/main/java/com/adyen/model/management/SofortInfo.java @@ -63,6 +63,11 @@ public String getCurrencyCode() { } + /** + * Sofort currency code. For example, **EUR**. + * + * @param currencyCode + */ @JsonProperty(JSON_PROPERTY_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyCode(String currencyCode) { @@ -88,6 +93,11 @@ public String getLogo() { } + /** + * Sofort logo. Format: Base64-encoded string. + * + * @param logo + */ @JsonProperty(JSON_PROPERTY_LOGO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLogo(String logo) { diff --git a/src/main/java/com/adyen/model/management/SplitConfiguration.java b/src/main/java/com/adyen/model/management/SplitConfiguration.java index d760c8e27..92ca93006 100644 --- a/src/main/java/com/adyen/model/management/SplitConfiguration.java +++ b/src/main/java/com/adyen/model/management/SplitConfiguration.java @@ -74,6 +74,11 @@ public String getDescription() { } + /** + * Your description for the split configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -104,6 +109,11 @@ public List getRules() { } + /** + * Array of rules that define the split configuration behavior. + * + * @param rules + */ @JsonProperty(JSON_PROPERTY_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRules(List rules) { @@ -129,6 +139,11 @@ public String getSplitConfigurationId() { } + /** + * Unique identifier of the split configuration. + * + * @param splitConfigurationId + */ @JsonProperty(JSON_PROPERTY_SPLIT_CONFIGURATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitConfigurationId(String splitConfigurationId) { @@ -162,6 +177,11 @@ public List getStores() { } + /** + * List of stores to which the split configuration applies. + * + * @param stores + */ @JsonProperty(JSON_PROPERTY_STORES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStores(List stores) { diff --git a/src/main/java/com/adyen/model/management/SplitConfigurationList.java b/src/main/java/com/adyen/model/management/SplitConfigurationList.java index 41a7272bd..87db4b6f0 100644 --- a/src/main/java/com/adyen/model/management/SplitConfigurationList.java +++ b/src/main/java/com/adyen/model/management/SplitConfigurationList.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * List of split configurations applied to the stores under the merchant account. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/SplitConfigurationLogic.java b/src/main/java/com/adyen/model/management/SplitConfigurationLogic.java index 076f48b6d..19353a819 100644 --- a/src/main/java/com/adyen/model/management/SplitConfigurationLogic.java +++ b/src/main/java/com/adyen/model/management/SplitConfigurationLogic.java @@ -539,6 +539,11 @@ public AcquiringFeesEnum getAcquiringFees() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param acquiringFees + */ @JsonProperty(JSON_PROPERTY_ACQUIRING_FEES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquiringFees(AcquiringFeesEnum acquiringFees) { @@ -564,6 +569,11 @@ public AdditionalCommission getAdditionalCommission() { } + /** + * additionalCommission + * + * @param additionalCommission + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_COMMISSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalCommission(AdditionalCommission additionalCommission) { @@ -589,6 +599,11 @@ public AdyenCommissionEnum getAdyenCommission() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param adyenCommission + */ @JsonProperty(JSON_PROPERTY_ADYEN_COMMISSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenCommission(AdyenCommissionEnum adyenCommission) { @@ -614,6 +629,11 @@ public AdyenFeesEnum getAdyenFees() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param adyenFees + */ @JsonProperty(JSON_PROPERTY_ADYEN_FEES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenFees(AdyenFeesEnum adyenFees) { @@ -639,6 +659,11 @@ public AdyenMarkupEnum getAdyenMarkup() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param adyenMarkup + */ @JsonProperty(JSON_PROPERTY_ADYEN_MARKUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenMarkup(AdyenMarkupEnum adyenMarkup) { @@ -664,6 +689,11 @@ public ChargebackEnum getChargeback() { } + /** + * Specifies the logic to apply when booking the chargeback amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. + * + * @param chargeback + */ @JsonProperty(JSON_PROPERTY_CHARGEBACK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChargeback(ChargebackEnum chargeback) { @@ -689,6 +719,11 @@ public ChargebackCostAllocationEnum getChargebackCostAllocation() { } + /** + * Specifies the logic to apply when allocating the chargeback costs. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount** + * + * @param chargebackCostAllocation + */ @JsonProperty(JSON_PROPERTY_CHARGEBACK_COST_ALLOCATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChargebackCostAllocation(ChargebackCostAllocationEnum chargebackCostAllocation) { @@ -714,6 +749,11 @@ public Commission getCommission() { } + /** + * commission + * + * @param commission + */ @JsonProperty(JSON_PROPERTY_COMMISSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommission(Commission commission) { @@ -739,6 +779,11 @@ public InterchangeEnum getInterchange() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param interchange + */ @JsonProperty(JSON_PROPERTY_INTERCHANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterchange(InterchangeEnum interchange) { @@ -764,6 +809,11 @@ public PaymentFeeEnum getPaymentFee() { } + /** + * Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param paymentFee + */ @JsonProperty(JSON_PROPERTY_PAYMENT_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentFee(PaymentFeeEnum paymentFee) { @@ -789,6 +839,11 @@ public RemainderEnum getRemainder() { } + /** + * Specifies the logic to apply when booking the amount left over after currency conversion. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**. + * + * @param remainder + */ @JsonProperty(JSON_PROPERTY_REMAINDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemainder(RemainderEnum remainder) { @@ -814,6 +869,11 @@ public SchemeFeeEnum getSchemeFee() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param schemeFee + */ @JsonProperty(JSON_PROPERTY_SCHEME_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSchemeFee(SchemeFeeEnum schemeFee) { @@ -839,6 +899,11 @@ public String getSplitLogicId() { } + /** + * Unique identifier of the split logic that is applied when the split configuration conditions are met. + * + * @param splitLogicId + */ @JsonProperty(JSON_PROPERTY_SPLIT_LOGIC_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitLogicId(String splitLogicId) { @@ -864,6 +929,11 @@ public SurchargeEnum getSurcharge() { } + /** + * Specifies the logic to apply when booking the surcharge amount. Possible values: **addToLiableAccount**, **addToOneBalanceAccount** + * + * @param surcharge + */ @JsonProperty(JSON_PROPERTY_SURCHARGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSurcharge(SurchargeEnum surcharge) { @@ -889,6 +959,11 @@ public TipEnum getTip() { } + /** + * Specifies the logic to apply when booking tips (gratuity). Possible values: **addToLiableAccount**, **addToOneBalanceAccount**. + * + * @param tip + */ @JsonProperty(JSON_PROPERTY_TIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTip(TipEnum tip) { diff --git a/src/main/java/com/adyen/model/management/SplitConfigurationRule.java b/src/main/java/com/adyen/model/management/SplitConfigurationRule.java index 2f83ef127..bbdc0a38e 100644 --- a/src/main/java/com/adyen/model/management/SplitConfigurationRule.java +++ b/src/main/java/com/adyen/model/management/SplitConfigurationRule.java @@ -158,6 +158,11 @@ public String getCurrency() { } + /** + * The currency condition that defines whether the split logic applies. Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -183,6 +188,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source condition of the payment method (only for cards). Possible values: **credit**, **debit**, or **ANY**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -208,6 +218,11 @@ public String getPaymentMethod() { } + /** + * The payment method condition that defines whether the split logic applies. Possible values: * [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method. * **ANY**: Apply the split logic for all available payment methods. + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -233,6 +248,11 @@ public String getRuleId() { } + /** + * The unique identifier of the split configuration rule. + * + * @param ruleId + */ @JsonProperty(JSON_PROPERTY_RULE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRuleId(String ruleId) { @@ -258,6 +278,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * The sales channel condition that defines whether the split logic applies. Possible values: * **Ecommerce**: Online transactions where the cardholder is present. * **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). * **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone. * **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal. * **ANY**: All sales channels. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -283,6 +308,11 @@ public SplitConfigurationLogic getSplitLogic() { } + /** + * splitLogic + * + * @param splitLogic + */ @JsonProperty(JSON_PROPERTY_SPLIT_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitLogic(SplitConfigurationLogic splitLogic) { diff --git a/src/main/java/com/adyen/model/management/Standalone.java b/src/main/java/com/adyen/model/management/Standalone.java index 2b5debece..f7ff83259 100644 --- a/src/main/java/com/adyen/model/management/Standalone.java +++ b/src/main/java/com/adyen/model/management/Standalone.java @@ -63,6 +63,11 @@ public String getCurrencyCode() { } + /** + * The default currency of the standalone payment terminal as an [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. + * + * @param currencyCode + */ @JsonProperty(JSON_PROPERTY_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencyCode(String currencyCode) { @@ -88,6 +93,11 @@ public Boolean getEnableStandalone() { } + /** + * Enable standalone mode. + * + * @param enableStandalone + */ @JsonProperty(JSON_PROPERTY_ENABLE_STANDALONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnableStandalone(Boolean enableStandalone) { diff --git a/src/main/java/com/adyen/model/management/Store.java b/src/main/java/com/adyen/model/management/Store.java index 5ba5b86d6..456dcff3f 100644 --- a/src/main/java/com/adyen/model/management/Store.java +++ b/src/main/java/com/adyen/model/management/Store.java @@ -145,6 +145,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -170,6 +175,11 @@ public StoreLocation getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(StoreLocation address) { @@ -203,6 +213,11 @@ public List getBusinessLineIds() { } + /** + * The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account. + * + * @param businessLineIds + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineIds(List businessLineIds) { @@ -228,6 +243,11 @@ public String getDescription() { } + /** + * The description of the store. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -253,6 +273,11 @@ public String getExternalReferenceId() { } + /** + * When using the Zip payment method: The location ID that Zip has assigned to your store. + * + * @param externalReferenceId + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_REFERENCE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalReferenceId(String externalReferenceId) { @@ -278,6 +303,11 @@ public String getId() { } + /** + * The unique identifier of the store. This value is generated by Adyen. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -303,6 +333,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account that the store belongs to. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -328,6 +363,11 @@ public String getPhoneNumber() { } + /** + * The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -353,6 +393,11 @@ public String getReference() { } + /** + * A reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_) + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -378,6 +423,11 @@ public String getShopperStatement() { } + /** + * The store name shown on the shopper's bank or credit card statement and on the shopper receipt. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -403,6 +453,11 @@ public StoreSplitConfiguration getSplitConfiguration() { } + /** + * splitConfiguration + * + * @param splitConfiguration + */ @JsonProperty(JSON_PROPERTY_SPLIT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitConfiguration(StoreSplitConfiguration splitConfiguration) { @@ -428,6 +483,11 @@ public StatusEnum getStatus() { } + /** + * The status of the store. Possible values are: - **active**. This value is assigned automatically when a store is created. - **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible. - **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/management/StoreCreationRequest.java b/src/main/java/com/adyen/model/management/StoreCreationRequest.java index 73d309076..2bb9a96c9 100644 --- a/src/main/java/com/adyen/model/management/StoreCreationRequest.java +++ b/src/main/java/com/adyen/model/management/StoreCreationRequest.java @@ -91,6 +91,11 @@ public StoreLocation getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(StoreLocation address) { @@ -124,6 +129,11 @@ public List getBusinessLineIds() { } + /** + * The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account. + * + * @param businessLineIds + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineIds(List businessLineIds) { @@ -149,6 +159,11 @@ public String getDescription() { } + /** + * Your description of the store. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -174,6 +189,11 @@ public String getExternalReferenceId() { } + /** + * The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits. Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators. Optional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations. + * + * @param externalReferenceId + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_REFERENCE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalReferenceId(String externalReferenceId) { @@ -199,6 +219,11 @@ public String getPhoneNumber() { } + /** + * The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -224,6 +249,11 @@ public String getReference() { } + /** + * Your reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_). If you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id). + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -249,6 +279,11 @@ public String getShopperStatement() { } + /** + * The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -274,6 +309,11 @@ public StoreSplitConfiguration getSplitConfiguration() { } + /** + * splitConfiguration + * + * @param splitConfiguration + */ @JsonProperty(JSON_PROPERTY_SPLIT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitConfiguration(StoreSplitConfiguration splitConfiguration) { diff --git a/src/main/java/com/adyen/model/management/StoreCreationWithMerchantCodeRequest.java b/src/main/java/com/adyen/model/management/StoreCreationWithMerchantCodeRequest.java index c8fefc17e..6a7e10281 100644 --- a/src/main/java/com/adyen/model/management/StoreCreationWithMerchantCodeRequest.java +++ b/src/main/java/com/adyen/model/management/StoreCreationWithMerchantCodeRequest.java @@ -95,6 +95,11 @@ public StoreLocation getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(StoreLocation address) { @@ -128,6 +133,11 @@ public List getBusinessLineIds() { } + /** + * The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/legalentity/latest/post/businessLines#responses-200-id) that the store is associated with. If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account. + * + * @param businessLineIds + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineIds(List businessLineIds) { @@ -153,6 +163,11 @@ public String getDescription() { } + /** + * Your description of the store. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -178,6 +193,11 @@ public String getExternalReferenceId() { } + /** + * The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits. Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators. Optional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations. + * + * @param externalReferenceId + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_REFERENCE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalReferenceId(String externalReferenceId) { @@ -203,6 +223,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account that the store belongs to. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -228,6 +253,11 @@ public String getPhoneNumber() { } + /** + * The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -253,6 +283,11 @@ public String getReference() { } + /** + * Your reference to recognize the store by. Also known as the store code. Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_). If you do not provide a reference in your POST request, it is populated with the Adyen-generated [id](https://docs.adyen.com/api-explorer/Management/latest/post/stores#responses-200-id). + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -278,6 +313,11 @@ public String getShopperStatement() { } + /** + * The store name to be shown on the shopper's bank or credit card statement and on the shopper receipt. Maximum length: 22 characters; can't be all numbers. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -303,6 +343,11 @@ public StoreSplitConfiguration getSplitConfiguration() { } + /** + * splitConfiguration + * + * @param splitConfiguration + */ @JsonProperty(JSON_PROPERTY_SPLIT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitConfiguration(StoreSplitConfiguration splitConfiguration) { diff --git a/src/main/java/com/adyen/model/management/StoreLocation.java b/src/main/java/com/adyen/model/management/StoreLocation.java index f139e12ef..2dda8148f 100644 --- a/src/main/java/com/adyen/model/management/StoreLocation.java +++ b/src/main/java/com/adyen/model/management/StoreLocation.java @@ -83,6 +83,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -108,6 +113,11 @@ public String getCountry() { } + /** + * The two-letter country code in [ISO_3166-1_alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -133,6 +143,11 @@ public String getLine1() { } + /** + * The street address. + * + * @param line1 + */ @JsonProperty(JSON_PROPERTY_LINE1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine1(String line1) { @@ -158,6 +173,11 @@ public String getLine2() { } + /** + * Second address line. + * + * @param line2 + */ @JsonProperty(JSON_PROPERTY_LINE2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine2(String line2) { @@ -183,6 +203,11 @@ public String getLine3() { } + /** + * Third address line. + * + * @param line3 + */ @JsonProperty(JSON_PROPERTY_LINE3) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine3(String line3) { @@ -208,6 +233,11 @@ public String getPostalCode() { } + /** + * The postal code. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -233,6 +263,11 @@ public String getStateOrProvince() { } + /** + * The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada. Required for the following countries: - Australia - Brazil - Canada - India - Mexico - New Zealand - United States + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { diff --git a/src/main/java/com/adyen/model/management/StoreSplitConfiguration.java b/src/main/java/com/adyen/model/management/StoreSplitConfiguration.java index 4ee026363..22062dc61 100644 --- a/src/main/java/com/adyen/model/management/StoreSplitConfiguration.java +++ b/src/main/java/com/adyen/model/management/StoreSplitConfiguration.java @@ -63,6 +63,11 @@ public String getBalanceAccountId() { } + /** + * The [unique identifier of the balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/get/balanceAccounts/{id}__queryParam_id) to which the split amount must be booked, depending on the defined [split logic](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/splitConfigurations#request-rules-splitLogic). + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -88,6 +93,11 @@ public String getSplitConfigurationId() { } + /** + * The unique identifier of the [split configuration profile](https://docs.adyen.com/marketplaces-and-platforms/automatic-split-configuration/create-split-configuration/). + * + * @param splitConfigurationId + */ @JsonProperty(JSON_PROPERTY_SPLIT_CONFIGURATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitConfigurationId(String splitConfigurationId) { diff --git a/src/main/java/com/adyen/model/management/Surcharge.java b/src/main/java/com/adyen/model/management/Surcharge.java index 933a161eb..20fd259b1 100644 --- a/src/main/java/com/adyen/model/management/Surcharge.java +++ b/src/main/java/com/adyen/model/management/Surcharge.java @@ -66,6 +66,11 @@ public Boolean getAskConfirmation() { } + /** + * Show the surcharge details on the terminal, so the shopper can confirm. + * + * @param askConfirmation + */ @JsonProperty(JSON_PROPERTY_ASK_CONFIRMATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAskConfirmation(Boolean askConfirmation) { @@ -99,6 +104,11 @@ public List getConfigurations() { } + /** + * Surcharge fees or percentages for specific payment methods, funding sources (credit or debit), and currencies. + * + * @param configurations + */ @JsonProperty(JSON_PROPERTY_CONFIGURATIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConfigurations(List configurations) { diff --git a/src/main/java/com/adyen/model/management/SwishInfo.java b/src/main/java/com/adyen/model/management/SwishInfo.java index 789d8fda1..513a9ef2a 100644 --- a/src/main/java/com/adyen/model/management/SwishInfo.java +++ b/src/main/java/com/adyen/model/management/SwishInfo.java @@ -59,6 +59,11 @@ public String getSwishNumber() { } + /** + * Swish number. Format: 10 digits without spaces. For example, **1231111111**. + * + * @param swishNumber + */ @JsonProperty(JSON_PROPERTY_SWISH_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSwishNumber(String swishNumber) { diff --git a/src/main/java/com/adyen/model/management/TapToPay.java b/src/main/java/com/adyen/model/management/TapToPay.java new file mode 100644 index 000000000..128e6d349 --- /dev/null +++ b/src/main/java/com/adyen/model/management/TapToPay.java @@ -0,0 +1,133 @@ +/* + * Management API + * + * The version of the OpenAPI document: 3 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.management; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * TapToPay + */ +@JsonPropertyOrder({ + TapToPay.JSON_PROPERTY_MERCHANT_DISPLAY_NAME +}) + +public class TapToPay { + public static final String JSON_PROPERTY_MERCHANT_DISPLAY_NAME = "merchantDisplayName"; + private String merchantDisplayName; + + public TapToPay() { + } + + public TapToPay merchantDisplayName(String merchantDisplayName) { + this.merchantDisplayName = merchantDisplayName; + return this; + } + + /** + * The text shown on the screen during the Tap to Pay transaction. + * @return merchantDisplayName + **/ + @ApiModelProperty(value = "The text shown on the screen during the Tap to Pay transaction.") + @JsonProperty(JSON_PROPERTY_MERCHANT_DISPLAY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMerchantDisplayName() { + return merchantDisplayName; + } + + + /** + * The text shown on the screen during the Tap to Pay transaction. + * + * @param merchantDisplayName + */ + @JsonProperty(JSON_PROPERTY_MERCHANT_DISPLAY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMerchantDisplayName(String merchantDisplayName) { + this.merchantDisplayName = merchantDisplayName; + } + + + /** + * Return true if this TapToPay object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TapToPay tapToPay = (TapToPay) o; + return Objects.equals(this.merchantDisplayName, tapToPay.merchantDisplayName); + } + + @Override + public int hashCode() { + return Objects.hash(merchantDisplayName); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TapToPay {\n"); + sb.append(" merchantDisplayName: ").append(toIndentedString(merchantDisplayName)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of TapToPay given an JSON string + * + * @param jsonString JSON string + * @return An instance of TapToPay + * @throws JsonProcessingException if the JSON string is invalid with respect to TapToPay + */ + public static TapToPay fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, TapToPay.class); + } +/** + * Convert an instance of TapToPay to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/management/Terminal.java b/src/main/java/com/adyen/model/management/Terminal.java index 11e79758f..61fd3d35a 100644 --- a/src/main/java/com/adyen/model/management/Terminal.java +++ b/src/main/java/com/adyen/model/management/Terminal.java @@ -90,6 +90,11 @@ public TerminalAssignment getAssignment() { } + /** + * assignment + * + * @param assignment + */ @JsonProperty(JSON_PROPERTY_ASSIGNMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssignment(TerminalAssignment assignment) { @@ -115,6 +120,11 @@ public TerminalConnectivity getConnectivity() { } + /** + * connectivity + * + * @param connectivity + */ @JsonProperty(JSON_PROPERTY_CONNECTIVITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConnectivity(TerminalConnectivity connectivity) { @@ -140,6 +150,11 @@ public String getFirmwareVersion() { } + /** + * The software release currently in use on the terminal. + * + * @param firmwareVersion + */ @JsonProperty(JSON_PROPERTY_FIRMWARE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirmwareVersion(String firmwareVersion) { @@ -165,6 +180,11 @@ public String getId() { } + /** + * The unique identifier of the terminal. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -190,6 +210,11 @@ public OffsetDateTime getLastActivityAt() { } + /** + * Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago. + * + * @param lastActivityAt + */ @JsonProperty(JSON_PROPERTY_LAST_ACTIVITY_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastActivityAt(OffsetDateTime lastActivityAt) { @@ -215,6 +240,11 @@ public OffsetDateTime getLastTransactionAt() { } + /** + * Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago. + * + * @param lastTransactionAt + */ @JsonProperty(JSON_PROPERTY_LAST_TRANSACTION_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastTransactionAt(OffsetDateTime lastTransactionAt) { @@ -240,6 +270,11 @@ public String getModel() { } + /** + * The model name of the terminal. + * + * @param model + */ @JsonProperty(JSON_PROPERTY_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModel(String model) { @@ -265,6 +300,11 @@ public String getSerialNumber() { } + /** + * The serial number of the terminal. + * + * @param serialNumber + */ @JsonProperty(JSON_PROPERTY_SERIAL_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSerialNumber(String serialNumber) { diff --git a/src/main/java/com/adyen/model/management/TerminalActionScheduleDetail.java b/src/main/java/com/adyen/model/management/TerminalActionScheduleDetail.java index d6de630e0..1dcd16488 100644 --- a/src/main/java/com/adyen/model/management/TerminalActionScheduleDetail.java +++ b/src/main/java/com/adyen/model/management/TerminalActionScheduleDetail.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * The ID of the action on the specified terminal. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getTerminalId() { } + /** + * The unique ID of the terminal that the action applies to. + * + * @param terminalId + */ @JsonProperty(JSON_PROPERTY_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalId(String terminalId) { diff --git a/src/main/java/com/adyen/model/management/TerminalAssignment.java b/src/main/java/com/adyen/model/management/TerminalAssignment.java index eaee21190..e93f87611 100644 --- a/src/main/java/com/adyen/model/management/TerminalAssignment.java +++ b/src/main/java/com/adyen/model/management/TerminalAssignment.java @@ -115,6 +115,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account to which terminal is assigned. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -140,6 +145,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account to which terminal is assigned. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -165,6 +175,11 @@ public TerminalReassignmentTarget getReassignmentTarget() { } + /** + * reassignmentTarget + * + * @param reassignmentTarget + */ @JsonProperty(JSON_PROPERTY_REASSIGNMENT_TARGET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReassignmentTarget(TerminalReassignmentTarget reassignmentTarget) { @@ -190,6 +205,11 @@ public StatusEnum getStatus() { } + /** + * The status of the reassignment. Possible values: * `reassignmentInProgress`: the terminal was boarded and is now scheduled to remove the configuration. Wait for the terminal to synchronize with the Adyen platform. * `deployed`: the terminal is deployed and reassigned. * `inventory`: the terminal is in inventory and cannot process transactions. * `boarded`: the terminal is boarded to a store, or a merchant account representing a store, and can process transactions. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -215,6 +235,11 @@ public String getStoreId() { } + /** + * The unique identifier of the store to which terminal is assigned. + * + * @param storeId + */ @JsonProperty(JSON_PROPERTY_STORE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreId(String storeId) { diff --git a/src/main/java/com/adyen/model/management/TerminalConnectivity.java b/src/main/java/com/adyen/model/management/TerminalConnectivity.java index ba2f33a80..917fcde93 100644 --- a/src/main/java/com/adyen/model/management/TerminalConnectivity.java +++ b/src/main/java/com/adyen/model/management/TerminalConnectivity.java @@ -75,6 +75,11 @@ public TerminalConnectivityBluetooth getBluetooth() { } + /** + * bluetooth + * + * @param bluetooth + */ @JsonProperty(JSON_PROPERTY_BLUETOOTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBluetooth(TerminalConnectivityBluetooth bluetooth) { @@ -100,6 +105,11 @@ public TerminalConnectivityCellular getCellular() { } + /** + * cellular + * + * @param cellular + */ @JsonProperty(JSON_PROPERTY_CELLULAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCellular(TerminalConnectivityCellular cellular) { @@ -125,6 +135,11 @@ public TerminalConnectivityEthernet getEthernet() { } + /** + * ethernet + * + * @param ethernet + */ @JsonProperty(JSON_PROPERTY_ETHERNET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEthernet(TerminalConnectivityEthernet ethernet) { @@ -150,6 +165,11 @@ public TerminalConnectivityWifi getWifi() { } + /** + * wifi + * + * @param wifi + */ @JsonProperty(JSON_PROPERTY_WIFI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWifi(TerminalConnectivityWifi wifi) { diff --git a/src/main/java/com/adyen/model/management/TerminalConnectivityBluetooth.java b/src/main/java/com/adyen/model/management/TerminalConnectivityBluetooth.java index ac5ff6157..769099851 100644 --- a/src/main/java/com/adyen/model/management/TerminalConnectivityBluetooth.java +++ b/src/main/java/com/adyen/model/management/TerminalConnectivityBluetooth.java @@ -63,6 +63,11 @@ public String getIpAddress() { } + /** + * The terminal's Bluetooth IP address. + * + * @param ipAddress + */ @JsonProperty(JSON_PROPERTY_IP_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIpAddress(String ipAddress) { @@ -88,6 +93,11 @@ public String getMacAddress() { } + /** + * The terminal's Bluetooth MAC address. + * + * @param macAddress + */ @JsonProperty(JSON_PROPERTY_MAC_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMacAddress(String macAddress) { diff --git a/src/main/java/com/adyen/model/management/TerminalConnectivityCellular.java b/src/main/java/com/adyen/model/management/TerminalConnectivityCellular.java index 26eb043ff..75cb442bd 100644 --- a/src/main/java/com/adyen/model/management/TerminalConnectivityCellular.java +++ b/src/main/java/com/adyen/model/management/TerminalConnectivityCellular.java @@ -104,6 +104,11 @@ public String getIccid() { } + /** + * The integrated circuit card identifier (ICCID) of the SIM card in the terminal. + * + * @param iccid + */ @JsonProperty(JSON_PROPERTY_ICCID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIccid(String iccid) { @@ -129,6 +134,11 @@ public StatusEnum getStatus() { } + /** + * On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/management/TerminalConnectivityEthernet.java b/src/main/java/com/adyen/model/management/TerminalConnectivityEthernet.java index 733cdb957..147e81842 100644 --- a/src/main/java/com/adyen/model/management/TerminalConnectivityEthernet.java +++ b/src/main/java/com/adyen/model/management/TerminalConnectivityEthernet.java @@ -67,6 +67,11 @@ public String getIpAddress() { } + /** + * The terminal's ethernet IP address. + * + * @param ipAddress + */ @JsonProperty(JSON_PROPERTY_IP_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIpAddress(String ipAddress) { @@ -92,6 +97,11 @@ public String getLinkNegotiation() { } + /** + * The ethernet link negotiation that the terminal uses. + * + * @param linkNegotiation + */ @JsonProperty(JSON_PROPERTY_LINK_NEGOTIATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinkNegotiation(String linkNegotiation) { @@ -117,6 +127,11 @@ public String getMacAddress() { } + /** + * The terminal's ethernet MAC address. + * + * @param macAddress + */ @JsonProperty(JSON_PROPERTY_MAC_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMacAddress(String macAddress) { diff --git a/src/main/java/com/adyen/model/management/TerminalConnectivityWifi.java b/src/main/java/com/adyen/model/management/TerminalConnectivityWifi.java index 893ab3991..d6f62ede2 100644 --- a/src/main/java/com/adyen/model/management/TerminalConnectivityWifi.java +++ b/src/main/java/com/adyen/model/management/TerminalConnectivityWifi.java @@ -67,6 +67,11 @@ public String getIpAddress() { } + /** + * The terminal's IP address in the Wi-Fi network. + * + * @param ipAddress + */ @JsonProperty(JSON_PROPERTY_IP_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIpAddress(String ipAddress) { @@ -92,6 +97,11 @@ public String getMacAddress() { } + /** + * The terminal's MAC address in the Wi-Fi network. + * + * @param macAddress + */ @JsonProperty(JSON_PROPERTY_MAC_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMacAddress(String macAddress) { @@ -117,6 +127,11 @@ public String getSsid() { } + /** + * The SSID of the Wi-Fi network that the terminal is connected to. + * + * @param ssid + */ @JsonProperty(JSON_PROPERTY_SSID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSsid(String ssid) { diff --git a/src/main/java/com/adyen/model/management/TerminalModelsResponse.java b/src/main/java/com/adyen/model/management/TerminalModelsResponse.java index 59f2ee220..c77f8b4bc 100644 --- a/src/main/java/com/adyen/model/management/TerminalModelsResponse.java +++ b/src/main/java/com/adyen/model/management/TerminalModelsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * The terminal models that the API credential has access to. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/TerminalOrder.java b/src/main/java/com/adyen/model/management/TerminalOrder.java index 6992a89ad..d7e5158c4 100644 --- a/src/main/java/com/adyen/model/management/TerminalOrder.java +++ b/src/main/java/com/adyen/model/management/TerminalOrder.java @@ -92,6 +92,11 @@ public BillingEntity getBillingEntity() { } + /** + * billingEntity + * + * @param billingEntity + */ @JsonProperty(JSON_PROPERTY_BILLING_ENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingEntity(BillingEntity billingEntity) { @@ -117,6 +122,11 @@ public String getCustomerOrderReference() { } + /** + * The merchant-defined purchase order number. This will be printed on the packing list. + * + * @param customerOrderReference + */ @JsonProperty(JSON_PROPERTY_CUSTOMER_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomerOrderReference(String customerOrderReference) { @@ -142,6 +152,11 @@ public String getId() { } + /** + * The unique identifier of the order. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -175,6 +190,11 @@ public List getItems() { } + /** + * The products included in the order. + * + * @param items + */ @JsonProperty(JSON_PROPERTY_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItems(List items) { @@ -200,6 +220,11 @@ public String getOrderDate() { } + /** + * The date and time that the order was placed, in UTC ISO 8601 format. For example, \"2011-12-03T10:15:30Z\". + * + * @param orderDate + */ @JsonProperty(JSON_PROPERTY_ORDER_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderDate(String orderDate) { @@ -225,6 +250,11 @@ public ShippingLocation getShippingLocation() { } + /** + * shippingLocation + * + * @param shippingLocation + */ @JsonProperty(JSON_PROPERTY_SHIPPING_LOCATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShippingLocation(ShippingLocation shippingLocation) { @@ -250,6 +280,11 @@ public String getStatus() { } + /** + * The processing status of the order. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { @@ -275,6 +310,11 @@ public String getTrackingUrl() { } + /** + * The URL, provided by the carrier company, where the shipment can be tracked. + * + * @param trackingUrl + */ @JsonProperty(JSON_PROPERTY_TRACKING_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrackingUrl(String trackingUrl) { diff --git a/src/main/java/com/adyen/model/management/TerminalOrderRequest.java b/src/main/java/com/adyen/model/management/TerminalOrderRequest.java index 93943d7eb..bbda8ca6a 100644 --- a/src/main/java/com/adyen/model/management/TerminalOrderRequest.java +++ b/src/main/java/com/adyen/model/management/TerminalOrderRequest.java @@ -82,6 +82,11 @@ public String getBillingEntityId() { } + /** + * The identification of the billing entity to use for the order. + * + * @param billingEntityId + */ @JsonProperty(JSON_PROPERTY_BILLING_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingEntityId(String billingEntityId) { @@ -107,6 +112,11 @@ public String getCustomerOrderReference() { } + /** + * The merchant-defined purchase order reference. + * + * @param customerOrderReference + */ @JsonProperty(JSON_PROPERTY_CUSTOMER_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomerOrderReference(String customerOrderReference) { @@ -140,6 +150,11 @@ public List getItems() { } + /** + * The products included in the order. + * + * @param items + */ @JsonProperty(JSON_PROPERTY_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItems(List items) { @@ -165,6 +180,11 @@ public String getOrderType() { } + /** + * Type of order + * + * @param orderType + */ @JsonProperty(JSON_PROPERTY_ORDER_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderType(String orderType) { @@ -190,6 +210,11 @@ public String getShippingLocationId() { } + /** + * The identification of the shipping location to use for the order. + * + * @param shippingLocationId + */ @JsonProperty(JSON_PROPERTY_SHIPPING_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShippingLocationId(String shippingLocationId) { @@ -215,6 +240,11 @@ public String getTaxId() { } + /** + * The tax number of the billing entity. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/management/TerminalOrdersResponse.java b/src/main/java/com/adyen/model/management/TerminalOrdersResponse.java index 3030a8b34..1e547666f 100644 --- a/src/main/java/com/adyen/model/management/TerminalOrdersResponse.java +++ b/src/main/java/com/adyen/model/management/TerminalOrdersResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * List of orders for payment terminal packages and parts. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/TerminalProduct.java b/src/main/java/com/adyen/model/management/TerminalProduct.java index 4840d37a4..d5cec882b 100644 --- a/src/main/java/com/adyen/model/management/TerminalProduct.java +++ b/src/main/java/com/adyen/model/management/TerminalProduct.java @@ -78,6 +78,11 @@ public String getDescription() { } + /** + * Information about items included and integration options. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -103,6 +108,11 @@ public String getId() { } + /** + * The unique identifier of the product. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -136,6 +146,11 @@ public List getItemsIncluded() { } + /** + * A list of parts included in the terminal package. + * + * @param itemsIncluded + */ @JsonProperty(JSON_PROPERTY_ITEMS_INCLUDED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setItemsIncluded(List itemsIncluded) { @@ -161,6 +176,11 @@ public String getName() { } + /** + * The descriptive name of the product. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -186,6 +206,11 @@ public TerminalProductPrice getPrice() { } + /** + * price + * + * @param price + */ @JsonProperty(JSON_PROPERTY_PRICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrice(TerminalProductPrice price) { diff --git a/src/main/java/com/adyen/model/management/TerminalProductPrice.java b/src/main/java/com/adyen/model/management/TerminalProductPrice.java index 0609ede0b..9fbbf1efd 100644 --- a/src/main/java/com/adyen/model/management/TerminalProductPrice.java +++ b/src/main/java/com/adyen/model/management/TerminalProductPrice.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Double getValue() { } + /** + * The price of the item. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Double value) { diff --git a/src/main/java/com/adyen/model/management/TerminalProductsResponse.java b/src/main/java/com/adyen/model/management/TerminalProductsResponse.java index c07eec208..c86ad44aa 100644 --- a/src/main/java/com/adyen/model/management/TerminalProductsResponse.java +++ b/src/main/java/com/adyen/model/management/TerminalProductsResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * Terminal products that can be ordered. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/TerminalReassignmentRequest.java b/src/main/java/com/adyen/model/management/TerminalReassignmentRequest.java index 3b088495c..9bc1a7461 100644 --- a/src/main/java/com/adyen/model/management/TerminalReassignmentRequest.java +++ b/src/main/java/com/adyen/model/management/TerminalReassignmentRequest.java @@ -71,6 +71,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account to which the terminal is reassigned. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -96,6 +101,11 @@ public Boolean getInventory() { } + /** + * Must be specified when reassigning terminals to a merchant account: - If set to **true**, reassigns terminals to the inventory of the merchant account and the terminals cannot process transactions. - If set to **false**, reassigns terminals directly to the merchant account and the terminals can process transactions. + * + * @param inventory + */ @JsonProperty(JSON_PROPERTY_INVENTORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInventory(Boolean inventory) { @@ -121,6 +131,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account to which the terminal is reassigned. When reassigning terminals to a merchant account, you must specify the `inventory` field. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -146,6 +161,11 @@ public String getStoreId() { } + /** + * The unique identifier of the store to which the terminal is reassigned. + * + * @param storeId + */ @JsonProperty(JSON_PROPERTY_STORE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreId(String storeId) { diff --git a/src/main/java/com/adyen/model/management/TerminalReassignmentTarget.java b/src/main/java/com/adyen/model/management/TerminalReassignmentTarget.java index e0bdd6e96..aa47a2a4e 100644 --- a/src/main/java/com/adyen/model/management/TerminalReassignmentTarget.java +++ b/src/main/java/com/adyen/model/management/TerminalReassignmentTarget.java @@ -71,6 +71,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account to which the terminal is reassigned. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -96,6 +101,11 @@ public Boolean getInventory() { } + /** + * Indicates if the terminal is reassigned to the inventory of the merchant account. - If **true**, the terminal is in the inventory of the merchant account and cannot process transactions. - If **false**, the terminal is reassigned directly to the merchant account and can process transactions. + * + * @param inventory + */ @JsonProperty(JSON_PROPERTY_INVENTORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInventory(Boolean inventory) { @@ -121,6 +131,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account to which the terminal is reassigned. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -146,6 +161,11 @@ public String getStoreId() { } + /** + * The unique identifier of the store to which the terminal is reassigned. + * + * @param storeId + */ @JsonProperty(JSON_PROPERTY_STORE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreId(String storeId) { diff --git a/src/main/java/com/adyen/model/management/TerminalSettings.java b/src/main/java/com/adyen/model/management/TerminalSettings.java index ff13d6da1..3c23ec9fc 100644 --- a/src/main/java/com/adyen/model/management/TerminalSettings.java +++ b/src/main/java/com/adyen/model/management/TerminalSettings.java @@ -32,6 +32,7 @@ import com.adyen.model.management.Signature; import com.adyen.model.management.Standalone; import com.adyen.model.management.Surcharge; +import com.adyen.model.management.TapToPay; import com.adyen.model.management.Timeouts; import com.adyen.model.management.WifiProfiles; import com.fasterxml.jackson.annotation.JsonInclude; @@ -67,6 +68,7 @@ TerminalSettings.JSON_PROPERTY_SIGNATURE, TerminalSettings.JSON_PROPERTY_STANDALONE, TerminalSettings.JSON_PROPERTY_SURCHARGE, + TerminalSettings.JSON_PROPERTY_TAP_TO_PAY, TerminalSettings.JSON_PROPERTY_TIMEOUTS, TerminalSettings.JSON_PROPERTY_WIFI_PROFILES }) @@ -120,6 +122,9 @@ public class TerminalSettings { public static final String JSON_PROPERTY_SURCHARGE = "surcharge"; private Surcharge surcharge; + public static final String JSON_PROPERTY_TAP_TO_PAY = "tapToPay"; + private TapToPay tapToPay; + public static final String JSON_PROPERTY_TIMEOUTS = "timeouts"; private Timeouts timeouts; @@ -147,6 +152,11 @@ public CardholderReceipt getCardholderReceipt() { } + /** + * cardholderReceipt + * + * @param cardholderReceipt + */ @JsonProperty(JSON_PROPERTY_CARDHOLDER_RECEIPT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardholderReceipt(CardholderReceipt cardholderReceipt) { @@ -172,6 +182,11 @@ public Connectivity getConnectivity() { } + /** + * connectivity + * + * @param connectivity + */ @JsonProperty(JSON_PROPERTY_CONNECTIVITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setConnectivity(Connectivity connectivity) { @@ -205,6 +220,11 @@ public List getGratuities() { } + /** + * Settings for tipping with or without predefined options to choose from. The maximum number of predefined options is four, or three plus the option to enter a custom tip. + * + * @param gratuities + */ @JsonProperty(JSON_PROPERTY_GRATUITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGratuities(List gratuities) { @@ -230,6 +250,11 @@ public Hardware getHardware() { } + /** + * hardware + * + * @param hardware + */ @JsonProperty(JSON_PROPERTY_HARDWARE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHardware(Hardware hardware) { @@ -255,6 +280,11 @@ public Localization getLocalization() { } + /** + * localization + * + * @param localization + */ @JsonProperty(JSON_PROPERTY_LOCALIZATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalization(Localization localization) { @@ -280,6 +310,11 @@ public Nexo getNexo() { } + /** + * nexo + * + * @param nexo + */ @JsonProperty(JSON_PROPERTY_NEXO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNexo(Nexo nexo) { @@ -305,6 +340,11 @@ public OfflineProcessing getOfflineProcessing() { } + /** + * offlineProcessing + * + * @param offlineProcessing + */ @JsonProperty(JSON_PROPERTY_OFFLINE_PROCESSING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOfflineProcessing(OfflineProcessing offlineProcessing) { @@ -330,6 +370,11 @@ public Opi getOpi() { } + /** + * opi + * + * @param opi + */ @JsonProperty(JSON_PROPERTY_OPI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpi(Opi opi) { @@ -355,6 +400,11 @@ public Passcodes getPasscodes() { } + /** + * passcodes + * + * @param passcodes + */ @JsonProperty(JSON_PROPERTY_PASSCODES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPasscodes(Passcodes passcodes) { @@ -380,6 +430,11 @@ public PayAtTable getPayAtTable() { } + /** + * payAtTable + * + * @param payAtTable + */ @JsonProperty(JSON_PROPERTY_PAY_AT_TABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayAtTable(PayAtTable payAtTable) { @@ -405,6 +460,11 @@ public Payment getPayment() { } + /** + * payment + * + * @param payment + */ @JsonProperty(JSON_PROPERTY_PAYMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayment(Payment payment) { @@ -430,6 +490,11 @@ public ReceiptOptions getReceiptOptions() { } + /** + * receiptOptions + * + * @param receiptOptions + */ @JsonProperty(JSON_PROPERTY_RECEIPT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceiptOptions(ReceiptOptions receiptOptions) { @@ -455,6 +520,11 @@ public ReceiptPrinting getReceiptPrinting() { } + /** + * receiptPrinting + * + * @param receiptPrinting + */ @JsonProperty(JSON_PROPERTY_RECEIPT_PRINTING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceiptPrinting(ReceiptPrinting receiptPrinting) { @@ -480,6 +550,11 @@ public Signature getSignature() { } + /** + * signature + * + * @param signature + */ @JsonProperty(JSON_PROPERTY_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignature(Signature signature) { @@ -505,6 +580,11 @@ public Standalone getStandalone() { } + /** + * standalone + * + * @param standalone + */ @JsonProperty(JSON_PROPERTY_STANDALONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStandalone(Standalone standalone) { @@ -530,6 +610,11 @@ public Surcharge getSurcharge() { } + /** + * surcharge + * + * @param surcharge + */ @JsonProperty(JSON_PROPERTY_SURCHARGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSurcharge(Surcharge surcharge) { @@ -537,6 +622,36 @@ public void setSurcharge(Surcharge surcharge) { } + public TerminalSettings tapToPay(TapToPay tapToPay) { + this.tapToPay = tapToPay; + return this; + } + + /** + * Get tapToPay + * @return tapToPay + **/ + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_TAP_TO_PAY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TapToPay getTapToPay() { + return tapToPay; + } + + + /** + * tapToPay + * + * @param tapToPay + */ + @JsonProperty(JSON_PROPERTY_TAP_TO_PAY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTapToPay(TapToPay tapToPay) { + this.tapToPay = tapToPay; + } + + public TerminalSettings timeouts(Timeouts timeouts) { this.timeouts = timeouts; return this; @@ -555,6 +670,11 @@ public Timeouts getTimeouts() { } + /** + * timeouts + * + * @param timeouts + */ @JsonProperty(JSON_PROPERTY_TIMEOUTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeouts(Timeouts timeouts) { @@ -580,6 +700,11 @@ public WifiProfiles getWifiProfiles() { } + /** + * wifiProfiles + * + * @param wifiProfiles + */ @JsonProperty(JSON_PROPERTY_WIFI_PROFILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWifiProfiles(WifiProfiles wifiProfiles) { @@ -615,13 +740,14 @@ public boolean equals(Object o) { Objects.equals(this.signature, terminalSettings.signature) && Objects.equals(this.standalone, terminalSettings.standalone) && Objects.equals(this.surcharge, terminalSettings.surcharge) && + Objects.equals(this.tapToPay, terminalSettings.tapToPay) && Objects.equals(this.timeouts, terminalSettings.timeouts) && Objects.equals(this.wifiProfiles, terminalSettings.wifiProfiles); } @Override public int hashCode() { - return Objects.hash(cardholderReceipt, connectivity, gratuities, hardware, localization, nexo, offlineProcessing, opi, passcodes, payAtTable, payment, receiptOptions, receiptPrinting, signature, standalone, surcharge, timeouts, wifiProfiles); + return Objects.hash(cardholderReceipt, connectivity, gratuities, hardware, localization, nexo, offlineProcessing, opi, passcodes, payAtTable, payment, receiptOptions, receiptPrinting, signature, standalone, surcharge, tapToPay, timeouts, wifiProfiles); } @Override @@ -644,6 +770,7 @@ public String toString() { sb.append(" signature: ").append(toIndentedString(signature)).append("\n"); sb.append(" standalone: ").append(toIndentedString(standalone)).append("\n"); sb.append(" surcharge: ").append(toIndentedString(surcharge)).append("\n"); + sb.append(" tapToPay: ").append(toIndentedString(tapToPay)).append("\n"); sb.append(" timeouts: ").append(toIndentedString(timeouts)).append("\n"); sb.append(" wifiProfiles: ").append(toIndentedString(wifiProfiles)).append("\n"); sb.append("}"); diff --git a/src/main/java/com/adyen/model/management/TestCompanyWebhookRequest.java b/src/main/java/com/adyen/model/management/TestCompanyWebhookRequest.java index e0698905a..ee1445b39 100644 --- a/src/main/java/com/adyen/model/management/TestCompanyWebhookRequest.java +++ b/src/main/java/com/adyen/model/management/TestCompanyWebhookRequest.java @@ -78,6 +78,11 @@ public List getMerchantIds() { } + /** + * List of `merchantId` values for which test webhooks will be sent. The list can have a maximum of 20 `merchantId` values. If not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications. + * + * @param merchantIds + */ @JsonProperty(JSON_PROPERTY_MERCHANT_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantIds(List merchantIds) { @@ -103,6 +108,11 @@ public CustomNotification getNotification() { } + /** + * notification + * + * @param notification + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotification(CustomNotification notification) { @@ -136,6 +146,11 @@ public List getTypes() { } + /** + * List of event codes for which to send test notifications. Only the webhook types below are supported. Possible values if webhook `type`: **standard**: * **AUTHORISATION** * **CHARGEBACK_REVERSED** * **ORDER_CLOSED** * **ORDER_OPENED** * **PAIDOUT_REVERSED** * **PAYOUT_THIRDPARTY** * **REFUNDED_REVERSED** * **REFUND_WITH_DATA** * **REPORT_AVAILABLE** * **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object. Possible values if webhook `type`: **banktransfer-notification**: * **PENDING** Possible values if webhook `type`: **report-notification**: * **REPORT_AVAILABLE** Possible values if webhook `type`: **ideal-notification**: * **AUTHORISATION** Possible values if webhook `type`: **pending-notification**: * **PENDING** + * + * @param types + */ @JsonProperty(JSON_PROPERTY_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTypes(List types) { diff --git a/src/main/java/com/adyen/model/management/TestOutput.java b/src/main/java/com/adyen/model/management/TestOutput.java index 246f462a3..59139c00b 100644 --- a/src/main/java/com/adyen/model/management/TestOutput.java +++ b/src/main/java/com/adyen/model/management/TestOutput.java @@ -79,6 +79,11 @@ public String getMerchantId() { } + /** + * Unique identifier of the merchant account that the notification is about. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -104,6 +109,11 @@ public String getOutput() { } + /** + * The response your server returned for the test webhook. Your server must respond with **[accepted]** for the test webhook to be successful (`data.status`: **success**). Find out more about [accepting notifications](https://docs.adyen.com/development-resources/webhooks#accept-notifications) You can use the value of this field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot unsuccessful test webhooks. + * + * @param output + */ @JsonProperty(JSON_PROPERTY_OUTPUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOutput(String output) { @@ -129,6 +139,11 @@ public String getRequestSent() { } + /** + * The [body of the notification webhook](https://docs.adyen.com/development-resources/webhooks/understand-notifications#notification-structure) that was sent to your server. + * + * @param requestSent + */ @JsonProperty(JSON_PROPERTY_REQUEST_SENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestSent(String requestSent) { @@ -154,6 +169,11 @@ public String getResponseCode() { } + /** + * The HTTP response code for your server's response to the test webhook. You can use the value of this field together with the the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field value to troubleshoot failed test webhooks. + * + * @param responseCode + */ @JsonProperty(JSON_PROPERTY_RESPONSE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponseCode(String responseCode) { @@ -179,6 +199,11 @@ public String getResponseTime() { } + /** + * The time between sending the test webhook and receiving the response from your server. You can use it as an indication of how long your server takes to process a webhook notification. Measured in milliseconds, for example **304 ms**. + * + * @param responseTime + */ @JsonProperty(JSON_PROPERTY_RESPONSE_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponseTime(String responseTime) { @@ -204,6 +229,11 @@ public String getStatus() { } + /** + * The status of the test request. Possible values are: * **success**, if `data.output`: **[accepted]** and `data.responseCode`: **200**. * **failed**, in all other cases. You can use the value of the [`output`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-output) field together with the [`responseCode`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/merchants/{merchantId}/webhooks/{id}/test__resParam_data-responseCode) value to troubleshoot failed test webhooks. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/management/TestWebhookRequest.java b/src/main/java/com/adyen/model/management/TestWebhookRequest.java index 7ac5263ce..961ba291c 100644 --- a/src/main/java/com/adyen/model/management/TestWebhookRequest.java +++ b/src/main/java/com/adyen/model/management/TestWebhookRequest.java @@ -66,6 +66,11 @@ public CustomNotification getNotification() { } + /** + * notification + * + * @param notification + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotification(CustomNotification notification) { @@ -99,6 +104,11 @@ public List getTypes() { } + /** + * List of event codes for which to send test notifications. Only the webhook types below are supported. Possible values if webhook `type`: **standard**: * **AUTHORISATION** * **CHARGEBACK_REVERSED** * **ORDER_CLOSED** * **ORDER_OPENED** * **PAIDOUT_REVERSED** * **PAYOUT_THIRDPARTY** * **REFUNDED_REVERSED** * **REFUND_WITH_DATA** * **REPORT_AVAILABLE** * **CUSTOM** - set your custom notification fields in the [`notification`](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookId}/test__reqParam_notification) object. Possible values if webhook `type`: **banktransfer-notification**: * **PENDING** Possible values if webhook `type`: **report-notification**: * **REPORT_AVAILABLE** Possible values if webhook `type`: **ideal-notification**: * **AUTHORISATION** Possible values if webhook `type`: **pending-notification**: * **PENDING** + * + * @param types + */ @JsonProperty(JSON_PROPERTY_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTypes(List types) { diff --git a/src/main/java/com/adyen/model/management/TestWebhookResponse.java b/src/main/java/com/adyen/model/management/TestWebhookResponse.java index 58e81c7e1..5268a66c3 100644 --- a/src/main/java/com/adyen/model/management/TestWebhookResponse.java +++ b/src/main/java/com/adyen/model/management/TestWebhookResponse.java @@ -70,6 +70,11 @@ public List getData() { } + /** + * List with test results. Each test webhook we send has a list element with the result. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/management/Timeouts.java b/src/main/java/com/adyen/model/management/Timeouts.java index a24134869..916a0d36e 100644 --- a/src/main/java/com/adyen/model/management/Timeouts.java +++ b/src/main/java/com/adyen/model/management/Timeouts.java @@ -59,6 +59,11 @@ public Integer getFromActiveToSleep() { } + /** + * Indicates the number of seconds of inactivity after which the terminal display goes into sleep mode. + * + * @param fromActiveToSleep + */ @JsonProperty(JSON_PROPERTY_FROM_ACTIVE_TO_SLEEP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFromActiveToSleep(Integer fromActiveToSleep) { diff --git a/src/main/java/com/adyen/model/management/TransactionDescriptionInfo.java b/src/main/java/com/adyen/model/management/TransactionDescriptionInfo.java index c481d5bfb..bcb6f4fff 100644 --- a/src/main/java/com/adyen/model/management/TransactionDescriptionInfo.java +++ b/src/main/java/com/adyen/model/management/TransactionDescriptionInfo.java @@ -100,6 +100,11 @@ public String getDoingBusinessAsName() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param doingBusinessAsName + */ @JsonProperty(JSON_PROPERTY_DOING_BUSINESS_AS_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDoingBusinessAsName(String doingBusinessAsName) { @@ -125,6 +130,11 @@ public TypeEnum getType() { } + /** + * The type of transaction description you want to use: - **fixed**: The transaction description set in this request is used for all payments with this payment method. - **append**: The transaction description set in this request is used as a base for all payments with this payment method. The [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is appended to this base description. Note that if the combined length exceeds 22 characters, banks may truncate the string. - **dynamic**: Only the [transaction description set in the request to process the payment](https://docs.adyen.com/api-explorer/Checkout/70/post/sessions#request-shopperStatement) is used for payments with this payment method. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/management/TwintInfo.java b/src/main/java/com/adyen/model/management/TwintInfo.java index 496924823..1dc7d42f5 100644 --- a/src/main/java/com/adyen/model/management/TwintInfo.java +++ b/src/main/java/com/adyen/model/management/TwintInfo.java @@ -59,6 +59,11 @@ public String getLogo() { } + /** + * Twint logo. Format: Base64-encoded string. + * + * @param logo + */ @JsonProperty(JSON_PROPERTY_LOGO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLogo(String logo) { diff --git a/src/main/java/com/adyen/model/management/UninstallAndroidAppDetails.java b/src/main/java/com/adyen/model/management/UninstallAndroidAppDetails.java index e36bfdf0a..bb1198653 100644 --- a/src/main/java/com/adyen/model/management/UninstallAndroidAppDetails.java +++ b/src/main/java/com/adyen/model/management/UninstallAndroidAppDetails.java @@ -96,6 +96,11 @@ public String getAppId() { } + /** + * The unique identifier of the app to be uninstalled. + * + * @param appId + */ @JsonProperty(JSON_PROPERTY_APP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAppId(String appId) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * Type of terminal action: Uninstall an Android app. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/management/UninstallAndroidCertificateDetails.java b/src/main/java/com/adyen/model/management/UninstallAndroidCertificateDetails.java index b32a50de2..71c6eb156 100644 --- a/src/main/java/com/adyen/model/management/UninstallAndroidCertificateDetails.java +++ b/src/main/java/com/adyen/model/management/UninstallAndroidCertificateDetails.java @@ -96,6 +96,11 @@ public String getCertificateId() { } + /** + * The unique identifier of the certificate to be uninstalled. + * + * @param certificateId + */ @JsonProperty(JSON_PROPERTY_CERTIFICATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCertificateId(String certificateId) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * Type of terminal action: Uninstall an Android certificate. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/management/UpdatableAddress.java b/src/main/java/com/adyen/model/management/UpdatableAddress.java index e96ca2e6d..b6f2e2f85 100644 --- a/src/main/java/com/adyen/model/management/UpdatableAddress.java +++ b/src/main/java/com/adyen/model/management/UpdatableAddress.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getLine1() { } + /** + * The street address. + * + * @param line1 + */ @JsonProperty(JSON_PROPERTY_LINE1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine1(String line1) { @@ -129,6 +139,11 @@ public String getLine2() { } + /** + * Second address line. + * + * @param line2 + */ @JsonProperty(JSON_PROPERTY_LINE2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine2(String line2) { @@ -154,6 +169,11 @@ public String getLine3() { } + /** + * Third address line. + * + * @param line3 + */ @JsonProperty(JSON_PROPERTY_LINE3) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine3(String line3) { @@ -179,6 +199,11 @@ public String getPostalCode() { } + /** + * The postal code. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -204,6 +229,11 @@ public String getStateOrProvince() { } + /** + * The state or province code as defined in [ISO 3166-2](https://www.iso.org/standard/72483.html). For example, **ON** for Ontario, Canada. Required for the following countries: - Australia - Brazil - Canada - India - Mexico - New Zealand - United States + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { diff --git a/src/main/java/com/adyen/model/management/UpdateCompanyApiCredentialRequest.java b/src/main/java/com/adyen/model/management/UpdateCompanyApiCredentialRequest.java index 5a0459dec..4630dacaa 100644 --- a/src/main/java/com/adyen/model/management/UpdateCompanyApiCredentialRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateCompanyApiCredentialRequest.java @@ -77,6 +77,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -110,6 +115,11 @@ public List getAllowedOrigins() { } + /** + * The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -143,6 +153,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * List of merchant accounts that the API credential has access to. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -168,6 +183,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -201,6 +221,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { diff --git a/src/main/java/com/adyen/model/management/UpdateCompanyUserRequest.java b/src/main/java/com/adyen/model/management/UpdateCompanyUserRequest.java index 90cbd1b5a..3dd4ee59f 100644 --- a/src/main/java/com/adyen/model/management/UpdateCompanyUserRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateCompanyUserRequest.java @@ -94,6 +94,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -119,6 +124,11 @@ public Boolean getActive() { } + /** + * Indicates whether this user is active. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -152,6 +162,11 @@ public List getAssociatedMerchantAccounts() { } + /** + * The list of [merchant accounts](https://docs.adyen.com/account/account-structure#merchant-accounts) to associate the user with. + * + * @param associatedMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_ASSOCIATED_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAssociatedMerchantAccounts(List associatedMerchantAccounts) { @@ -177,6 +192,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -202,6 +222,11 @@ public Name2 getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name2 name) { @@ -235,6 +260,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -260,6 +290,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { diff --git a/src/main/java/com/adyen/model/management/UpdateCompanyWebhookRequest.java b/src/main/java/com/adyen/model/management/UpdateCompanyWebhookRequest.java index 1a57b359d..10d60e872 100644 --- a/src/main/java/com/adyen/model/management/UpdateCompanyWebhookRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateCompanyWebhookRequest.java @@ -264,6 +264,11 @@ public Boolean getAcceptsExpiredCertificate() { } + /** + * Indicates if expired SSL certificates are accepted. Default value: **false**. + * + * @param acceptsExpiredCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate) { @@ -289,6 +294,11 @@ public Boolean getAcceptsSelfSignedCertificate() { } + /** + * Indicates if self-signed SSL certificates are accepted. Default value: **false**. + * + * @param acceptsSelfSignedCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate) { @@ -314,6 +324,11 @@ public Boolean getAcceptsUntrustedRootCertificate() { } + /** + * Indicates if untrusted SSL certificates are accepted. Default value: **false**. + * + * @param acceptsUntrustedRootCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate) { @@ -339,6 +354,11 @@ public Boolean getActive() { } + /** + * Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -364,6 +384,11 @@ public AdditionalSettings getAdditionalSettings() { } + /** + * additionalSettings + * + * @param additionalSettings + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalSettings(AdditionalSettings additionalSettings) { @@ -389,6 +414,11 @@ public CommunicationFormatEnum getCommunicationFormat() { } + /** + * Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json** + * + * @param communicationFormat + */ @JsonProperty(JSON_PROPERTY_COMMUNICATION_FORMAT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommunicationFormat(CommunicationFormatEnum communicationFormat) { @@ -414,6 +444,11 @@ public String getDescription() { } + /** + * Your description for this webhook configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -439,6 +474,11 @@ public EncryptionProtocolEnum getEncryptionProtocol() { } + /** + * SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**. + * + * @param encryptionProtocol + */ @JsonProperty(JSON_PROPERTY_ENCRYPTION_PROTOCOL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptionProtocol(EncryptionProtocolEnum encryptionProtocol) { @@ -464,6 +504,11 @@ public FilterMerchantAccountTypeEnum getFilterMerchantAccountType() { } + /** + * Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **includeAccounts**: The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. * **excludeAccounts**: The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. * **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. + * + * @param filterMerchantAccountType + */ @JsonProperty(JSON_PROPERTY_FILTER_MERCHANT_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFilterMerchantAccountType(FilterMerchantAccountTypeEnum filterMerchantAccountType) { @@ -497,6 +542,11 @@ public List getFilterMerchantAccounts() { } + /** + * A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts** Not needed for `filterMerchantAccountType`: **allAccounts**. + * + * @param filterMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_FILTER_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFilterMerchantAccounts(List filterMerchantAccounts) { @@ -522,6 +572,11 @@ public NetworkTypeEnum getNetworkType() { } + /** + * Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**. + * + * @param networkType + */ @JsonProperty(JSON_PROPERTY_NETWORK_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkType(NetworkTypeEnum networkType) { @@ -547,6 +602,11 @@ public String getPassword() { } + /** + * Password to access the webhook URL. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -572,6 +632,11 @@ public Boolean getPopulateSoapActionHeader() { } + /** + * Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**. + * + * @param populateSoapActionHeader + */ @JsonProperty(JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPopulateSoapActionHeader(Boolean populateSoapActionHeader) { @@ -597,6 +662,11 @@ public String getUrl() { } + /** + * Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -622,6 +692,11 @@ public String getUsername() { } + /** + * Username to access the webhook URL. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/UpdateMerchantApiCredentialRequest.java b/src/main/java/com/adyen/model/management/UpdateMerchantApiCredentialRequest.java index 1199393c6..2f762f5a9 100644 --- a/src/main/java/com/adyen/model/management/UpdateMerchantApiCredentialRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateMerchantApiCredentialRequest.java @@ -73,6 +73,11 @@ public Boolean getActive() { } + /** + * Indicates if the API credential is enabled. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -106,6 +111,11 @@ public List getAllowedOrigins() { } + /** + * The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential. + * + * @param allowedOrigins + */ @JsonProperty(JSON_PROPERTY_ALLOWED_ORIGINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedOrigins(List allowedOrigins) { @@ -131,6 +141,11 @@ public String getDescription() { } + /** + * Description of the API credential. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -164,6 +179,11 @@ public List getRoles() { } + /** + * List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { diff --git a/src/main/java/com/adyen/model/management/UpdateMerchantUserRequest.java b/src/main/java/com/adyen/model/management/UpdateMerchantUserRequest.java index cff514e8f..c9aba5482 100644 --- a/src/main/java/com/adyen/model/management/UpdateMerchantUserRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateMerchantUserRequest.java @@ -90,6 +90,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -115,6 +120,11 @@ public Boolean getActive() { } + /** + * Sets the status of the user to active (**true**) or inactive (**false**). + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -140,6 +150,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -165,6 +180,11 @@ public Name2 getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name2 name) { @@ -198,6 +218,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -223,6 +248,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { diff --git a/src/main/java/com/adyen/model/management/UpdateMerchantWebhookRequest.java b/src/main/java/com/adyen/model/management/UpdateMerchantWebhookRequest.java index 9103c583f..4e93c5541 100644 --- a/src/main/java/com/adyen/model/management/UpdateMerchantWebhookRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateMerchantWebhookRequest.java @@ -217,6 +217,11 @@ public Boolean getAcceptsExpiredCertificate() { } + /** + * Indicates if expired SSL certificates are accepted. Default value: **false**. + * + * @param acceptsExpiredCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate) { @@ -242,6 +247,11 @@ public Boolean getAcceptsSelfSignedCertificate() { } + /** + * Indicates if self-signed SSL certificates are accepted. Default value: **false**. + * + * @param acceptsSelfSignedCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate) { @@ -267,6 +277,11 @@ public Boolean getAcceptsUntrustedRootCertificate() { } + /** + * Indicates if untrusted SSL certificates are accepted. Default value: **false**. + * + * @param acceptsUntrustedRootCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate) { @@ -292,6 +307,11 @@ public Boolean getActive() { } + /** + * Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -317,6 +337,11 @@ public AdditionalSettings getAdditionalSettings() { } + /** + * additionalSettings + * + * @param additionalSettings + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalSettings(AdditionalSettings additionalSettings) { @@ -342,6 +367,11 @@ public CommunicationFormatEnum getCommunicationFormat() { } + /** + * Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json** + * + * @param communicationFormat + */ @JsonProperty(JSON_PROPERTY_COMMUNICATION_FORMAT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommunicationFormat(CommunicationFormatEnum communicationFormat) { @@ -367,6 +397,11 @@ public String getDescription() { } + /** + * Your description for this webhook configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -392,6 +427,11 @@ public EncryptionProtocolEnum getEncryptionProtocol() { } + /** + * SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**. + * + * @param encryptionProtocol + */ @JsonProperty(JSON_PROPERTY_ENCRYPTION_PROTOCOL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptionProtocol(EncryptionProtocolEnum encryptionProtocol) { @@ -417,6 +457,11 @@ public NetworkTypeEnum getNetworkType() { } + /** + * Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**. + * + * @param networkType + */ @JsonProperty(JSON_PROPERTY_NETWORK_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkType(NetworkTypeEnum networkType) { @@ -442,6 +487,11 @@ public String getPassword() { } + /** + * Password to access the webhook URL. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -467,6 +517,11 @@ public Boolean getPopulateSoapActionHeader() { } + /** + * Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**. + * + * @param populateSoapActionHeader + */ @JsonProperty(JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPopulateSoapActionHeader(Boolean populateSoapActionHeader) { @@ -492,6 +547,11 @@ public String getUrl() { } + /** + * Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -517,6 +577,11 @@ public String getUsername() { } + /** + * Username to access the webhook URL. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/UpdatePaymentMethodInfo.java b/src/main/java/com/adyen/model/management/UpdatePaymentMethodInfo.java index eaec8f93f..052393258 100644 --- a/src/main/java/com/adyen/model/management/UpdatePaymentMethodInfo.java +++ b/src/main/java/com/adyen/model/management/UpdatePaymentMethodInfo.java @@ -128,6 +128,11 @@ public BcmcInfo getBcmc() { } + /** + * bcmc + * + * @param bcmc + */ @JsonProperty(JSON_PROPERTY_BCMC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBcmc(BcmcInfo bcmc) { @@ -153,6 +158,11 @@ public CartesBancairesInfo getCartesBancaires() { } + /** + * cartesBancaires + * + * @param cartesBancaires + */ @JsonProperty(JSON_PROPERTY_CARTES_BANCAIRES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCartesBancaires(CartesBancairesInfo cartesBancaires) { @@ -186,6 +196,11 @@ public List getCountries() { } + /** + * The list of countries where a payment method is available. By default, all countries supported by the payment method. + * + * @param countries + */ @JsonProperty(JSON_PROPERTY_COUNTRIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountries(List countries) { @@ -211,6 +226,11 @@ public GenericPmWithTdiInfo getCup() { } + /** + * cup + * + * @param cup + */ @JsonProperty(JSON_PROPERTY_CUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCup(GenericPmWithTdiInfo cup) { @@ -244,6 +264,11 @@ public List getCurrencies() { } + /** + * The list of currencies that a payment method supports. By default, all currencies supported by the payment method. + * + * @param currencies + */ @JsonProperty(JSON_PROPERTY_CURRENCIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrencies(List currencies) { @@ -269,6 +294,11 @@ public GenericPmWithTdiInfo getDiners() { } + /** + * diners + * + * @param diners + */ @JsonProperty(JSON_PROPERTY_DINERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiners(GenericPmWithTdiInfo diners) { @@ -294,6 +324,11 @@ public GenericPmWithTdiInfo getDiscover() { } + /** + * discover + * + * @param discover + */ @JsonProperty(JSON_PROPERTY_DISCOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDiscover(GenericPmWithTdiInfo discover) { @@ -319,6 +354,11 @@ public GenericPmWithTdiInfo getEftposAustralia() { } + /** + * eftposAustralia + * + * @param eftposAustralia + */ @JsonProperty(JSON_PROPERTY_EFTPOS_AUSTRALIA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEftposAustralia(GenericPmWithTdiInfo eftposAustralia) { @@ -344,6 +384,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the payment method is enabled (**true**) or disabled (**false**). + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -369,6 +414,11 @@ public GenericPmWithTdiInfo getGirocard() { } + /** + * girocard + * + * @param girocard + */ @JsonProperty(JSON_PROPERTY_GIROCARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGirocard(GenericPmWithTdiInfo girocard) { @@ -394,6 +444,11 @@ public GenericPmWithTdiInfo getIdeal() { } + /** + * ideal + * + * @param ideal + */ @JsonProperty(JSON_PROPERTY_IDEAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIdeal(GenericPmWithTdiInfo ideal) { @@ -419,6 +474,11 @@ public GenericPmWithTdiInfo getInteracCard() { } + /** + * interacCard + * + * @param interacCard + */ @JsonProperty(JSON_PROPERTY_INTERAC_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInteracCard(GenericPmWithTdiInfo interacCard) { @@ -444,6 +504,11 @@ public GenericPmWithTdiInfo getJcb() { } + /** + * jcb + * + * @param jcb + */ @JsonProperty(JSON_PROPERTY_JCB) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJcb(GenericPmWithTdiInfo jcb) { @@ -469,6 +534,11 @@ public GenericPmWithTdiInfo getMaestro() { } + /** + * maestro + * + * @param maestro + */ @JsonProperty(JSON_PROPERTY_MAESTRO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaestro(GenericPmWithTdiInfo maestro) { @@ -494,6 +564,11 @@ public GenericPmWithTdiInfo getMc() { } + /** + * mc + * + * @param mc + */ @JsonProperty(JSON_PROPERTY_MC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMc(GenericPmWithTdiInfo mc) { @@ -527,6 +602,11 @@ public List getStoreIds() { } + /** + * The list of stores for this payment method + * + * @param storeIds + */ @JsonProperty(JSON_PROPERTY_STORE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreIds(List storeIds) { @@ -552,6 +632,11 @@ public GenericPmWithTdiInfo getVisa() { } + /** + * visa + * + * @param visa + */ @JsonProperty(JSON_PROPERTY_VISA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisa(GenericPmWithTdiInfo visa) { diff --git a/src/main/java/com/adyen/model/management/UpdatePayoutSettingsRequest.java b/src/main/java/com/adyen/model/management/UpdatePayoutSettingsRequest.java index 2ac5f37f1..87bab3372 100644 --- a/src/main/java/com/adyen/model/management/UpdatePayoutSettingsRequest.java +++ b/src/main/java/com/adyen/model/management/UpdatePayoutSettingsRequest.java @@ -59,6 +59,11 @@ public Boolean getEnabled() { } + /** + * Indicates if payouts to this bank account are enabled. Default: **true**. To receive payouts into this bank account, both `enabled` and `allowed` must be **true**. + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { diff --git a/src/main/java/com/adyen/model/management/UpdateSplitConfigurationLogicRequest.java b/src/main/java/com/adyen/model/management/UpdateSplitConfigurationLogicRequest.java index c6214cd29..912716547 100644 --- a/src/main/java/com/adyen/model/management/UpdateSplitConfigurationLogicRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateSplitConfigurationLogicRequest.java @@ -539,6 +539,11 @@ public AcquiringFeesEnum getAcquiringFees() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with adyenFees. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param acquiringFees + */ @JsonProperty(JSON_PROPERTY_ACQUIRING_FEES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquiringFees(AcquiringFeesEnum acquiringFees) { @@ -564,6 +569,11 @@ public AdditionalCommission getAdditionalCommission() { } + /** + * additionalCommission + * + * @param additionalCommission + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_COMMISSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalCommission(AdditionalCommission additionalCommission) { @@ -589,6 +599,11 @@ public AdyenCommissionEnum getAdyenCommission() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, interchange & adyenMarkup. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param adyenCommission + */ @JsonProperty(JSON_PROPERTY_ADYEN_COMMISSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenCommission(AdyenCommissionEnum adyenCommission) { @@ -614,6 +629,11 @@ public AdyenFeesEnum getAdyenFees() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with acquiringFees. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param adyenFees + */ @JsonProperty(JSON_PROPERTY_ADYEN_FEES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenFees(AdyenFeesEnum adyenFees) { @@ -639,6 +659,11 @@ public AdyenMarkupEnum getAdyenMarkup() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & interchange. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param adyenMarkup + */ @JsonProperty(JSON_PROPERTY_ADYEN_MARKUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenMarkup(AdyenMarkupEnum adyenMarkup) { @@ -664,6 +689,11 @@ public ChargebackEnum getChargeback() { } + /** + * Specifies the logic to apply when booking the chargeback amount. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. + * + * @param chargeback + */ @JsonProperty(JSON_PROPERTY_CHARGEBACK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChargeback(ChargebackEnum chargeback) { @@ -689,6 +719,11 @@ public ChargebackCostAllocationEnum getChargebackCostAllocation() { } + /** + * Specifies the logic to apply when allocating the chargeback costs. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount** + * + * @param chargebackCostAllocation + */ @JsonProperty(JSON_PROPERTY_CHARGEBACK_COST_ALLOCATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChargebackCostAllocation(ChargebackCostAllocationEnum chargebackCostAllocation) { @@ -714,6 +749,11 @@ public Commission getCommission() { } + /** + * commission + * + * @param commission + */ @JsonProperty(JSON_PROPERTY_COMMISSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommission(Commission commission) { @@ -739,6 +779,11 @@ public InterchangeEnum getInterchange() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with schemeFee, adyenCommission & adyenMarkup. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param interchange + */ @JsonProperty(JSON_PROPERTY_INTERCHANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterchange(InterchangeEnum interchange) { @@ -764,6 +809,11 @@ public PaymentFeeEnum getPaymentFee() { } + /** + * Specifies the logic to apply when booking the transaction fees. Cannot be combined with other fees. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param paymentFee + */ @JsonProperty(JSON_PROPERTY_PAYMENT_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentFee(PaymentFeeEnum paymentFee) { @@ -789,6 +839,11 @@ public RemainderEnum getRemainder() { } + /** + * Specifies the logic to apply when booking the amount left over after currency conversion. Possible values: **addToLiableAccount**, **addToOneBalanceAccount**. + * + * @param remainder + */ @JsonProperty(JSON_PROPERTY_REMAINDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemainder(RemainderEnum remainder) { @@ -814,6 +869,11 @@ public SchemeFeeEnum getSchemeFee() { } + /** + * Specifies the logic to apply when booking the transaction fees. Should be combined with interchange, adyenCommission & adyenMarkup. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**. + * + * @param schemeFee + */ @JsonProperty(JSON_PROPERTY_SCHEME_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSchemeFee(SchemeFeeEnum schemeFee) { @@ -839,6 +899,11 @@ public String getSplitLogicId() { } + /** + * Unique identifier of the split logic that is applied when the split configuration conditions are met. + * + * @param splitLogicId + */ @JsonProperty(JSON_PROPERTY_SPLIT_LOGIC_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitLogicId(String splitLogicId) { @@ -864,6 +929,11 @@ public SurchargeEnum getSurcharge() { } + /** + * Specifies the logic to apply when booking the surcharge amount. Possible values: **addToLiableAccount**, **addToOneBalanceAccount** + * + * @param surcharge + */ @JsonProperty(JSON_PROPERTY_SURCHARGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSurcharge(SurchargeEnum surcharge) { @@ -889,6 +959,11 @@ public TipEnum getTip() { } + /** + * Specifies the logic to apply when booking tips (gratuity). Possible values: **addToLiableAccount**, **addToOneBalanceAccount**. + * + * @param tip + */ @JsonProperty(JSON_PROPERTY_TIP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTip(TipEnum tip) { diff --git a/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRequest.java b/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRequest.java index a84f5a781..2fb5989d0 100644 --- a/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRequest.java @@ -59,6 +59,11 @@ public String getDescription() { } + /** + * Your description for the split configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { diff --git a/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRuleRequest.java b/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRuleRequest.java index 35987858d..d0e5fdb67 100644 --- a/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRuleRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateSplitConfigurationRuleRequest.java @@ -71,6 +71,11 @@ public String getCurrency() { } + /** + * The currency condition that defines whether the split logic applies. Its value must be a three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -96,6 +101,11 @@ public String getFundingSource() { } + /** + * The funding source condition of the payment method (only for cards). Possible values: **credit**, **debit**, or **ANY**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(String fundingSource) { @@ -121,6 +131,11 @@ public String getPaymentMethod() { } + /** + * The payment method condition that defines whether the split logic applies. Possible values: * [Payment method variant](https://docs.adyen.com/development-resources/paymentmethodvariant): Apply the split logic for a specific payment method. * **ANY**: Apply the split logic for all available payment methods. + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -146,6 +161,11 @@ public String getShopperInteraction() { } + /** + * The sales channel condition that defines whether the split logic applies. Possible values: * **Ecommerce**: Online transactions where the cardholder is present. * **ContAuth**: Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). * **Moto**: Mail-order and telephone-order transactions where the customer is in contact with the merchant via email or telephone. * **POS**: Point-of-sale transactions where the customer is physically present to make a payment using a secure payment terminal. * **ANY**: All sales channels. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(String shopperInteraction) { diff --git a/src/main/java/com/adyen/model/management/UpdateStoreRequest.java b/src/main/java/com/adyen/model/management/UpdateStoreRequest.java index b5ddb69cd..678d4f561 100644 --- a/src/main/java/com/adyen/model/management/UpdateStoreRequest.java +++ b/src/main/java/com/adyen/model/management/UpdateStoreRequest.java @@ -124,6 +124,11 @@ public UpdatableAddress getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(UpdatableAddress address) { @@ -157,6 +162,11 @@ public List getBusinessLineIds() { } + /** + * The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__resParam_id) that the store is associated with. + * + * @param businessLineIds + */ @JsonProperty(JSON_PROPERTY_BUSINESS_LINE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBusinessLineIds(List businessLineIds) { @@ -182,6 +192,11 @@ public String getDescription() { } + /** + * The description of the store. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -207,6 +222,11 @@ public String getExternalReferenceId() { } + /** + * When using the Zip payment method: The location ID that Zip has assigned to your store. + * + * @param externalReferenceId + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_REFERENCE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalReferenceId(String externalReferenceId) { @@ -232,6 +252,11 @@ public String getPhoneNumber() { } + /** + * The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. + * + * @param phoneNumber + */ @JsonProperty(JSON_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPhoneNumber(String phoneNumber) { @@ -257,6 +282,11 @@ public StoreSplitConfiguration getSplitConfiguration() { } + /** + * splitConfiguration + * + * @param splitConfiguration + */ @JsonProperty(JSON_PROPERTY_SPLIT_CONFIGURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplitConfiguration(StoreSplitConfiguration splitConfiguration) { @@ -282,6 +312,11 @@ public StatusEnum getStatus() { } + /** + * The status of the store. Possible values are: - **active**: This value is assigned automatically when a store is created. - **inactive**: The maximum [transaction limits and number of Store-and-Forward transactions](https://docs.adyen.com/point-of-sale/determine-account-structure/configure-features#payment-features) for the store are set to 0. This blocks new transactions, but captures are still possible. - **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments. You can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**. Once **closed**, a store can't be reopened. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/management/UploadAndroidAppResponse.java b/src/main/java/com/adyen/model/management/UploadAndroidAppResponse.java index 87e416d5d..f0af7a48c 100644 --- a/src/main/java/com/adyen/model/management/UploadAndroidAppResponse.java +++ b/src/main/java/com/adyen/model/management/UploadAndroidAppResponse.java @@ -59,6 +59,11 @@ public String getId() { } + /** + * The unique identifier of the uploaded Android app. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/management/Url.java b/src/main/java/com/adyen/model/management/Url.java index 39aed014a..32dc3ba7e 100644 --- a/src/main/java/com/adyen/model/management/Url.java +++ b/src/main/java/com/adyen/model/management/Url.java @@ -71,6 +71,11 @@ public Boolean getEncrypted() { } + /** + * Indicates if the message sent to this URL should be encrypted. + * + * @param encrypted + */ @JsonProperty(JSON_PROPERTY_ENCRYPTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncrypted(Boolean encrypted) { @@ -96,6 +101,11 @@ public String getPassword() { } + /** + * The password for authentication of the notifications. + * + * @param password + */ @JsonProperty(JSON_PROPERTY_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPassword(String password) { @@ -121,6 +131,11 @@ public String getUrl() { } + /** + * The URL in the format: http(s)://domain.com. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -146,6 +161,11 @@ public String getUsername() { } + /** + * The username for authentication of the notifications. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/User.java b/src/main/java/com/adyen/model/management/User.java index 9e2545ba3..27e67b8d6 100644 --- a/src/main/java/com/adyen/model/management/User.java +++ b/src/main/java/com/adyen/model/management/User.java @@ -99,6 +99,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -132,6 +137,11 @@ public List getAccountGroups() { } + /** + * The list of [account groups](https://docs.adyen.com/account/account-structure#account-groups) associated with this user. + * + * @param accountGroups + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountGroups(List accountGroups) { @@ -157,6 +167,11 @@ public Boolean getActive() { } + /** + * Indicates whether this user is active. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -190,6 +205,11 @@ public List getApps() { } + /** + * Set of apps available to this user + * + * @param apps + */ @JsonProperty(JSON_PROPERTY_APPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApps(List apps) { @@ -215,6 +235,11 @@ public String getEmail() { } + /** + * The email address of the user. + * + * @param email + */ @JsonProperty(JSON_PROPERTY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEmail(String email) { @@ -240,6 +265,11 @@ public String getId() { } + /** + * The unique identifier of the user. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -265,6 +295,11 @@ public Name getName() { } + /** + * name + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(Name name) { @@ -295,6 +330,11 @@ public List getRoles() { } + /** + * The list of [roles](https://docs.adyen.com/account/user-roles) for this user. + * + * @param roles + */ @JsonProperty(JSON_PROPERTY_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoles(List roles) { @@ -320,6 +360,11 @@ public String getTimeZoneCode() { } + /** + * The [tz database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the time zone of the user. For example, **Europe/Amsterdam**. + * + * @param timeZoneCode + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneCode(String timeZoneCode) { @@ -345,6 +390,11 @@ public String getUsername() { } + /** + * The username for this user. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/VippsInfo.java b/src/main/java/com/adyen/model/management/VippsInfo.java index 63d1322a8..d9634cc65 100644 --- a/src/main/java/com/adyen/model/management/VippsInfo.java +++ b/src/main/java/com/adyen/model/management/VippsInfo.java @@ -63,6 +63,11 @@ public String getLogo() { } + /** + * Vipps logo. Format: Base64-encoded string. + * + * @param logo + */ @JsonProperty(JSON_PROPERTY_LOGO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLogo(String logo) { @@ -88,6 +93,11 @@ public String getSubscriptionCancelUrl() { } + /** + * Vipps subscription cancel url (required in case of [recurring payments](https://docs.adyen.com/online-payments/tokenization)) + * + * @param subscriptionCancelUrl + */ @JsonProperty(JSON_PROPERTY_SUBSCRIPTION_CANCEL_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubscriptionCancelUrl(String subscriptionCancelUrl) { diff --git a/src/main/java/com/adyen/model/management/Webhook.java b/src/main/java/com/adyen/model/management/Webhook.java index 797d39dc6..283027b6c 100644 --- a/src/main/java/com/adyen/model/management/Webhook.java +++ b/src/main/java/com/adyen/model/management/Webhook.java @@ -293,6 +293,11 @@ public WebhookLinks getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(WebhookLinks links) { @@ -318,6 +323,11 @@ public Boolean getAcceptsExpiredCertificate() { } + /** + * Indicates if expired SSL certificates are accepted. Default value: **false**. + * + * @param acceptsExpiredCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_EXPIRED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsExpiredCertificate(Boolean acceptsExpiredCertificate) { @@ -343,6 +353,11 @@ public Boolean getAcceptsSelfSignedCertificate() { } + /** + * Indicates if self-signed SSL certificates are accepted. Default value: **false**. + * + * @param acceptsSelfSignedCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_SELF_SIGNED_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsSelfSignedCertificate(Boolean acceptsSelfSignedCertificate) { @@ -368,6 +383,11 @@ public Boolean getAcceptsUntrustedRootCertificate() { } + /** + * Indicates if untrusted SSL certificates are accepted. Default value: **false**. + * + * @param acceptsUntrustedRootCertificate + */ @JsonProperty(JSON_PROPERTY_ACCEPTS_UNTRUSTED_ROOT_CERTIFICATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptsUntrustedRootCertificate(Boolean acceptsUntrustedRootCertificate) { @@ -393,6 +413,11 @@ public String getAccountReference() { } + /** + * Reference to the account the webook is set on. + * + * @param accountReference + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountReference(String accountReference) { @@ -418,6 +443,11 @@ public Boolean getActive() { } + /** + * Indicates if the webhook configuration is active. The field must be **true** for you to receive webhooks about events related an account. + * + * @param active + */ @JsonProperty(JSON_PROPERTY_ACTIVE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setActive(Boolean active) { @@ -443,6 +473,11 @@ public AdditionalSettingsResponse getAdditionalSettings() { } + /** + * additionalSettings + * + * @param additionalSettings + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalSettings(AdditionalSettingsResponse additionalSettings) { @@ -468,6 +503,11 @@ public String getCertificateAlias() { } + /** + * The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias. + * + * @param certificateAlias + */ @JsonProperty(JSON_PROPERTY_CERTIFICATE_ALIAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCertificateAlias(String certificateAlias) { @@ -493,6 +533,11 @@ public CommunicationFormatEnum getCommunicationFormat() { } + /** + * Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json** + * + * @param communicationFormat + */ @JsonProperty(JSON_PROPERTY_COMMUNICATION_FORMAT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCommunicationFormat(CommunicationFormatEnum communicationFormat) { @@ -518,6 +563,11 @@ public String getDescription() { } + /** + * Your description for this webhook configuration. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -543,6 +593,11 @@ public EncryptionProtocolEnum getEncryptionProtocol() { } + /** + * SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook will use `sslVersion`: **TLSv1.2**. + * + * @param encryptionProtocol + */ @JsonProperty(JSON_PROPERTY_ENCRYPTION_PROTOCOL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEncryptionProtocol(EncryptionProtocolEnum encryptionProtocol) { @@ -568,6 +623,11 @@ public FilterMerchantAccountTypeEnum getFilterMerchantAccountType() { } + /** + * Shows how merchant accounts are included in company-level webhooks. Possible values: * **includeAccounts** * **excludeAccounts** * **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. + * + * @param filterMerchantAccountType + */ @JsonProperty(JSON_PROPERTY_FILTER_MERCHANT_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFilterMerchantAccountType(FilterMerchantAccountTypeEnum filterMerchantAccountType) { @@ -601,6 +661,11 @@ public List getFilterMerchantAccounts() { } + /** + * A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`. Required if `filterMerchantAccountType` is either: * **includeAccounts** * **excludeAccounts** Not needed for `filterMerchantAccountType`: **allAccounts**. + * + * @param filterMerchantAccounts + */ @JsonProperty(JSON_PROPERTY_FILTER_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFilterMerchantAccounts(List filterMerchantAccounts) { @@ -626,6 +691,11 @@ public Boolean getHasError() { } + /** + * Indicates if the webhook configuration has errors that need troubleshooting. If the value is **true**, troubleshoot the configuration using the [testing endpoint](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookid}/test). + * + * @param hasError + */ @JsonProperty(JSON_PROPERTY_HAS_ERROR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasError(Boolean hasError) { @@ -651,6 +721,11 @@ public Boolean getHasPassword() { } + /** + * Indicates if the webhook is password protected. + * + * @param hasPassword + */ @JsonProperty(JSON_PROPERTY_HAS_PASSWORD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHasPassword(Boolean hasPassword) { @@ -676,6 +751,11 @@ public String getHmacKeyCheckValue() { } + /** + * The [checksum](https://en.wikipedia.org/wiki/Key_checksum_value) of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook. + * + * @param hmacKeyCheckValue + */ @JsonProperty(JSON_PROPERTY_HMAC_KEY_CHECK_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHmacKeyCheckValue(String hmacKeyCheckValue) { @@ -701,6 +781,11 @@ public String getId() { } + /** + * Unique identifier for this webhook. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -726,6 +811,11 @@ public NetworkTypeEnum getNetworkType() { } + /** + * Network type for Terminal API details webhooks. + * + * @param networkType + */ @JsonProperty(JSON_PROPERTY_NETWORK_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkType(NetworkTypeEnum networkType) { @@ -751,6 +841,11 @@ public Boolean getPopulateSoapActionHeader() { } + /** + * Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**. + * + * @param populateSoapActionHeader + */ @JsonProperty(JSON_PROPERTY_POPULATE_SOAP_ACTION_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPopulateSoapActionHeader(Boolean populateSoapActionHeader) { @@ -776,6 +871,11 @@ public String getType() { } + /** + * The type of webhook. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-notification-of-change-notification** - **pending-notification** - **ideal-notification** - **ideal-pending-notification** - **report-notification** - **terminal-api-notification** Find out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -801,6 +901,11 @@ public String getUrl() { } + /** + * Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**. + * + * @param url + */ @JsonProperty(JSON_PROPERTY_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUrl(String url) { @@ -826,6 +931,11 @@ public String getUsername() { } + /** + * Username to access the webhook URL. + * + * @param username + */ @JsonProperty(JSON_PROPERTY_USERNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUsername(String username) { diff --git a/src/main/java/com/adyen/model/management/WebhookLinks.java b/src/main/java/com/adyen/model/management/WebhookLinks.java index 6defbedfa..e04b63edf 100644 --- a/src/main/java/com/adyen/model/management/WebhookLinks.java +++ b/src/main/java/com/adyen/model/management/WebhookLinks.java @@ -76,6 +76,11 @@ public LinksElement getCompany() { } + /** + * company + * + * @param company + */ @JsonProperty(JSON_PROPERTY_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompany(LinksElement company) { @@ -101,6 +106,11 @@ public LinksElement getGenerateHmac() { } + /** + * generateHmac + * + * @param generateHmac + */ @JsonProperty(JSON_PROPERTY_GENERATE_HMAC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGenerateHmac(LinksElement generateHmac) { @@ -126,6 +136,11 @@ public LinksElement getMerchant() { } + /** + * merchant + * + * @param merchant + */ @JsonProperty(JSON_PROPERTY_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchant(LinksElement merchant) { @@ -151,6 +166,11 @@ public LinksElement getSelf() { } + /** + * self + * + * @param self + */ @JsonProperty(JSON_PROPERTY_SELF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelf(LinksElement self) { @@ -176,6 +196,11 @@ public LinksElement getTestWebhook() { } + /** + * testWebhook + * + * @param testWebhook + */ @JsonProperty(JSON_PROPERTY_TEST_WEBHOOK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTestWebhook(LinksElement testWebhook) { diff --git a/src/main/java/com/adyen/model/management/WifiProfiles.java b/src/main/java/com/adyen/model/management/WifiProfiles.java index dabf64043..ab07a0dab 100644 --- a/src/main/java/com/adyen/model/management/WifiProfiles.java +++ b/src/main/java/com/adyen/model/management/WifiProfiles.java @@ -75,6 +75,11 @@ public List getProfiles() { } + /** + * List of remote Wi-Fi profiles. + * + * @param profiles + */ @JsonProperty(JSON_PROPERTY_PROFILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProfiles(List profiles) { @@ -100,6 +105,11 @@ public Settings getSettings() { } + /** + * settings + * + * @param settings + */ @JsonProperty(JSON_PROPERTY_SETTINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSettings(Settings settings) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/AccountCapabilityData.java b/src/main/java/com/adyen/model/managementwebhooks/AccountCapabilityData.java index 0d99233a5..5a114dd0a 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/AccountCapabilityData.java +++ b/src/main/java/com/adyen/model/managementwebhooks/AccountCapabilityData.java @@ -24,6 +24,7 @@ import com.fasterxml.jackson.annotation.JsonValue; import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; +import java.time.OffsetDateTime; import java.util.ArrayList; import java.util.List; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -40,6 +41,7 @@ AccountCapabilityData.JSON_PROPERTY_PROBLEMS, AccountCapabilityData.JSON_PROPERTY_REQUESTED, AccountCapabilityData.JSON_PROPERTY_REQUESTED_LEVEL, + AccountCapabilityData.JSON_PROPERTY_VERIFICATION_DEADLINE, AccountCapabilityData.JSON_PROPERTY_VERIFICATION_STATUS }) @@ -62,6 +64,9 @@ public class AccountCapabilityData { public static final String JSON_PROPERTY_REQUESTED_LEVEL = "requestedLevel"; private String requestedLevel; + public static final String JSON_PROPERTY_VERIFICATION_DEADLINE = "verificationDeadline"; + private OffsetDateTime verificationDeadline; + public static final String JSON_PROPERTY_VERIFICATION_STATUS = "verificationStatus"; private String verificationStatus; @@ -86,6 +91,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether the capability is allowed. Adyen sets this to **true** if the verification is successful. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -111,6 +121,11 @@ public String getAllowedLevel() { } + /** + * The allowed level of the capability. Some capabilities have different levels which correspond to thresholds. Higher levels may require additional checks and increased monitoring.Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param allowedLevel + */ @JsonProperty(JSON_PROPERTY_ALLOWED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowedLevel(String allowedLevel) { @@ -136,6 +151,11 @@ public String getCapability() { } + /** + * The name of the capability. For example, **sendToTransferInstrument**. + * + * @param capability + */ @JsonProperty(JSON_PROPERTY_CAPABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapability(String capability) { @@ -169,6 +189,11 @@ public List getProblems() { } + /** + * List of entities that has problems with verification. The information includes the details of the errors and the actions that you can take to resolve them. + * + * @param problems + */ @JsonProperty(JSON_PROPERTY_PROBLEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProblems(List problems) { @@ -194,6 +219,11 @@ public Boolean getRequested() { } + /** + * Indicates whether you requested the capability. + * + * @param requested + */ @JsonProperty(JSON_PROPERTY_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequested(Boolean requested) { @@ -219,6 +249,11 @@ public String getRequestedLevel() { } + /** + * The level that you requested for the capability. Some capabilities have different levels which correspond to thresholds. Higher levels may require additional checks and increased monitoring.Possible values: **notApplicable**, **low**, **medium**, **high**. + * + * @param requestedLevel + */ @JsonProperty(JSON_PROPERTY_REQUESTED_LEVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedLevel(String requestedLevel) { @@ -226,6 +261,36 @@ public void setRequestedLevel(String requestedLevel) { } + public AccountCapabilityData verificationDeadline(OffsetDateTime verificationDeadline) { + this.verificationDeadline = verificationDeadline; + return this; + } + + /** + * The verification deadline for the capability that will be disallowed if verification errors are not resolved. + * @return verificationDeadline + **/ + @ApiModelProperty(value = "The verification deadline for the capability that will be disallowed if verification errors are not resolved.") + @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public OffsetDateTime getVerificationDeadline() { + return verificationDeadline; + } + + + /** + * The verification deadline for the capability that will be disallowed if verification errors are not resolved. + * + * @param verificationDeadline + */ + @JsonProperty(JSON_PROPERTY_VERIFICATION_DEADLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setVerificationDeadline(OffsetDateTime verificationDeadline) { + this.verificationDeadline = verificationDeadline; + } + + public AccountCapabilityData verificationStatus(String verificationStatus) { this.verificationStatus = verificationStatus; return this; @@ -244,6 +309,11 @@ public String getVerificationStatus() { } + /** + * The status of the verification checks for the capability. Possible values: * **pending**: Adyen is running the verification. * **invalid**: The verification failed. Check if the `errors` array contains more information. * **valid**: The verification was successful. * **rejected**: Adyen checked the information and found reasons to not allow the capability. + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(String verificationStatus) { @@ -269,12 +339,13 @@ public boolean equals(Object o) { Objects.equals(this.problems, accountCapabilityData.problems) && Objects.equals(this.requested, accountCapabilityData.requested) && Objects.equals(this.requestedLevel, accountCapabilityData.requestedLevel) && + Objects.equals(this.verificationDeadline, accountCapabilityData.verificationDeadline) && Objects.equals(this.verificationStatus, accountCapabilityData.verificationStatus); } @Override public int hashCode() { - return Objects.hash(allowed, allowedLevel, capability, problems, requested, requestedLevel, verificationStatus); + return Objects.hash(allowed, allowedLevel, capability, problems, requested, requestedLevel, verificationDeadline, verificationStatus); } @Override @@ -287,6 +358,7 @@ public String toString() { sb.append(" problems: ").append(toIndentedString(problems)).append("\n"); sb.append(" requested: ").append(toIndentedString(requested)).append("\n"); sb.append(" requestedLevel: ").append(toIndentedString(requestedLevel)).append("\n"); + sb.append(" verificationDeadline: ").append(toIndentedString(verificationDeadline)).append("\n"); sb.append(" verificationStatus: ").append(toIndentedString(verificationStatus)).append("\n"); sb.append("}"); return sb.toString(); diff --git a/src/main/java/com/adyen/model/managementwebhooks/AccountCreateNotificationData.java b/src/main/java/com/adyen/model/managementwebhooks/AccountCreateNotificationData.java index 63c252e5f..6925f5153 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/AccountCreateNotificationData.java +++ b/src/main/java/com/adyen/model/managementwebhooks/AccountCreateNotificationData.java @@ -84,6 +84,11 @@ public Map getCapabilities() { } + /** + * Key-value pairs that specify the actions that the merchant account can do and its settings. The key is a capability. For example, the **sendToTransferInstrument** is the capability required before you can pay out funds to the bank account. The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -109,6 +114,11 @@ public String getCompanyId() { } + /** + * The unique identifier of the company account. + * + * @param companyId + */ @JsonProperty(JSON_PROPERTY_COMPANY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyId(String companyId) { @@ -134,6 +144,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id). + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -159,6 +174,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -184,6 +204,11 @@ public String getStatus() { } + /** + * The status of the merchant account. Possible values: * **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments. * **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled. * **InactiveWithModifications**: Users can access the merchant account in the Customer Area. The account cannot process new payments but can still modify payments, for example issue refunds. The account can still receive payouts. * **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled. * **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/AccountNotificationResponse.java b/src/main/java/com/adyen/model/managementwebhooks/AccountNotificationResponse.java index e11b99c29..ed6bdbc34 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/AccountNotificationResponse.java +++ b/src/main/java/com/adyen/model/managementwebhooks/AccountNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/AccountUpdateNotificationData.java b/src/main/java/com/adyen/model/managementwebhooks/AccountUpdateNotificationData.java index 228c5975e..a5a791a2d 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/AccountUpdateNotificationData.java +++ b/src/main/java/com/adyen/model/managementwebhooks/AccountUpdateNotificationData.java @@ -80,6 +80,11 @@ public Map getCapabilities() { } + /** + * Key-value pairs that specify what you can do with the merchant account and its settings. The key is a capability. For example, the **sendToTransferInstrument** is the capability required before you can pay out the funds of a merchant account to a [bank account](https://docs.adyen.com/api-explorer/legalentity/latest/post/transferInstruments). The value is an object containing the settings for the capability. + * + * @param capabilities + */ @JsonProperty(JSON_PROPERTY_CAPABILITIES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCapabilities(Map capabilities) { @@ -105,6 +110,11 @@ public String getLegalEntityId() { } + /** + * The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/post/legalEntities#responses-200-id). + * + * @param legalEntityId + */ @JsonProperty(JSON_PROPERTY_LEGAL_ENTITY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLegalEntityId(String legalEntityId) { @@ -130,6 +140,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -155,6 +170,11 @@ public String getStatus() { } + /** + * The status of the merchant account. Possible values: * **PreActive**: The merchant account has been created. Users cannot access the merchant account in the Customer Area. The account cannot process payments. * **Active**: Users can access the merchant account in the Customer Area. If the company account is also **Active**, then payment processing and payouts are enabled. * **InactiveWithModifications**: Users can access the merchant account in the Customer Area. The account cannot process new payments but can still modify payments, for example issue refunds. The account can still receive payouts. * **Inactive**: Users can access the merchant account in the Customer Area. Payment processing and payouts are disabled. * **Closed**: The account is closed and this cannot be reversed. Users cannot log in. Payment processing and payouts are disabled. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblem.java b/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblem.java index bd4e99521..c956492cb 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblem.java +++ b/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblem.java @@ -67,6 +67,11 @@ public CapabilityProblemEntity getEntity() { } + /** + * entity + * + * @param entity + */ @JsonProperty(JSON_PROPERTY_ENTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntity(CapabilityProblemEntity entity) { @@ -100,6 +105,11 @@ public List getVerificationErrors() { } + /** + * List of verification errors. + * + * @param verificationErrors + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationErrors(List verificationErrors) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntity.java b/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntity.java index 17dafa0cd..7965bea93 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntity.java +++ b/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntity.java @@ -119,6 +119,11 @@ public List getDocuments() { } + /** + * List of document IDs to which the verification errors related to the capabilities correspond to. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -144,6 +149,11 @@ public String getId() { } + /** + * The ID of the entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -169,6 +179,11 @@ public CapabilityProblemEntityRecursive getOwner() { } + /** + * owner + * + * @param owner + */ @JsonProperty(JSON_PROPERTY_OWNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwner(CapabilityProblemEntityRecursive owner) { @@ -194,6 +209,11 @@ public TypeEnum getType() { } + /** + * The type of entity. Possible values: **LegalEntity**, **BankAccount**, or **Document**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntityRecursive.java b/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntityRecursive.java index fb3966731..b517a52a0 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntityRecursive.java +++ b/src/main/java/com/adyen/model/managementwebhooks/CapabilityProblemEntityRecursive.java @@ -115,6 +115,11 @@ public List getDocuments() { } + /** + * List of document IDs to which the verification errors related to the capabilities correspond to. + * + * @param documents + */ @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDocuments(List documents) { @@ -140,6 +145,11 @@ public String getId() { } + /** + * The ID of the entity. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -165,6 +175,11 @@ public TypeEnum getType() { } + /** + * The type of entity. Possible values: **LegalEntity**, **BankAccount**, or **Document**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/MerchantCreatedNotificationRequest.java b/src/main/java/com/adyen/model/managementwebhooks/MerchantCreatedNotificationRequest.java index 3f87f2778..ad1d3526a 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/MerchantCreatedNotificationRequest.java +++ b/src/main/java/com/adyen/model/managementwebhooks/MerchantCreatedNotificationRequest.java @@ -106,6 +106,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * Timestamp for when the webhook was created. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -131,6 +136,11 @@ public AccountCreateNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(AccountCreateNotificationData data) { @@ -156,6 +166,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -181,6 +196,11 @@ public TypeEnum getType() { } + /** + * Type of notification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/MerchantUpdatedNotificationRequest.java b/src/main/java/com/adyen/model/managementwebhooks/MerchantUpdatedNotificationRequest.java index 08a9bb7c6..f4a897bd7 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/MerchantUpdatedNotificationRequest.java +++ b/src/main/java/com/adyen/model/managementwebhooks/MerchantUpdatedNotificationRequest.java @@ -106,6 +106,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * Timestamp for when the webhook was created. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -131,6 +136,11 @@ public AccountUpdateNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(AccountUpdateNotificationData data) { @@ -156,6 +166,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -181,6 +196,11 @@ public TypeEnum getType() { } + /** + * Type of notification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/MidServiceNotificationData.java b/src/main/java/com/adyen/model/managementwebhooks/MidServiceNotificationData.java index 9ae5e90b8..6ff29aad1 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/MidServiceNotificationData.java +++ b/src/main/java/com/adyen/model/managementwebhooks/MidServiceNotificationData.java @@ -59,7 +59,7 @@ public class MidServiceNotificationData { private String reference; /** - * The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **dataRequired**: the request is in a draft state because the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_). * **capabilityPending**: the **receivePayments** capability is not allowed. * **updatesExpected**: the **receivePayments** capability is not allowed and the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_). + * The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **capabilityPending**: the **receivePayments** capability is not allowed. */ public enum StatusEnum { SUCCESS("success"), @@ -171,6 +171,11 @@ public Boolean getAllowed() { } + /** + * Indicates whether receiving payments is allowed. This value is set to **true** by Adyen after screening your merchant account. + * + * @param allowed + */ @JsonProperty(JSON_PROPERTY_ALLOWED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowed(Boolean allowed) { @@ -196,6 +201,11 @@ public Boolean getEnabled() { } + /** + * Indicates whether the payment method is enabled (**true**) or disabled (**false**). + * + * @param enabled + */ @JsonProperty(JSON_PROPERTY_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnabled(Boolean enabled) { @@ -221,6 +231,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -246,6 +261,11 @@ public String getMerchantId() { } + /** + * The unique identifier of the merchant account. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -271,6 +291,11 @@ public String getReference() { } + /** + * Your reference for the payment method. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -284,10 +309,10 @@ public MidServiceNotificationData status(StatusEnum status) { } /** - * The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **dataRequired**: the request is in a draft state because the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_). * **capabilityPending**: the **receivePayments** capability is not allowed. * **updatesExpected**: the **receivePayments** capability is not allowed and the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_). + * The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **capabilityPending**: the **receivePayments** capability is not allowed. * @return status **/ - @ApiModelProperty(required = true, value = "The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **dataRequired**: the request is in a draft state because the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_). * **capabilityPending**: the **receivePayments** capability is not allowed. * **updatesExpected**: the **receivePayments** capability is not allowed and the required KYC data are missing. To check what data are missing, [get the details of the legal entity](https://docs.adyen.com/api-explorer/legalentity/latest/get/legalEntities/_id_).") + @ApiModelProperty(required = true, value = "The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **capabilityPending**: the **receivePayments** capability is not allowed. ") @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -296,6 +321,11 @@ public StatusEnum getStatus() { } + /** + * The status of the request to add a payment method. Possible values: * **success**: the payment method was added. * **failure**: the request failed. * **capabilityPending**: the **receivePayments** capability is not allowed. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -321,6 +351,11 @@ public String getStoreId() { } + /** + * The unique identifier of the [store](https://docs.adyen.com/api-explorer/#/ManagementService/latest/post/merchants/{id}/paymentMethodSettings__reqParam_storeId), if any. + * + * @param storeId + */ @JsonProperty(JSON_PROPERTY_STORE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreId(String storeId) { @@ -346,6 +381,11 @@ public String getType() { } + /** + * Payment method [variant](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api). + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -371,6 +411,11 @@ public VerificationStatusEnum getVerificationStatus() { } + /** + * Payment method status. Possible values: * **valid** * **pending** * **invalid** * **rejected** + * + * @param verificationStatus + */ @JsonProperty(JSON_PROPERTY_VERIFICATION_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVerificationStatus(VerificationStatusEnum verificationStatus) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodCreatedNotificationRequest.java b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodCreatedNotificationRequest.java index 666eececd..5d72a5564 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodCreatedNotificationRequest.java +++ b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodCreatedNotificationRequest.java @@ -106,6 +106,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * Timestamp for when the webhook was created. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -131,6 +136,11 @@ public MidServiceNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(MidServiceNotificationData data) { @@ -156,6 +166,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -181,6 +196,11 @@ public TypeEnum getType() { } + /** + * Type of notification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodNotificationResponse.java b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodNotificationResponse.java index a623fc464..a09ea4c8d 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodNotificationResponse.java +++ b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodRequestRemovedNotificationRequest.java b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodRequestRemovedNotificationRequest.java index 47219cee3..e2e6d4a2f 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodRequestRemovedNotificationRequest.java +++ b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodRequestRemovedNotificationRequest.java @@ -106,6 +106,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * Timestamp for when the webhook was created. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -131,6 +136,11 @@ public MidServiceNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(MidServiceNotificationData data) { @@ -156,6 +166,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -181,6 +196,11 @@ public TypeEnum getType() { } + /** + * Type of notification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodScheduledForRemovalNotificationRequest.java b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodScheduledForRemovalNotificationRequest.java index eefd26450..f3a3bcb7e 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodScheduledForRemovalNotificationRequest.java +++ b/src/main/java/com/adyen/model/managementwebhooks/PaymentMethodScheduledForRemovalNotificationRequest.java @@ -106,6 +106,11 @@ public OffsetDateTime getCreatedAt() { } + /** + * Timestamp for when the webhook was created. + * + * @param createdAt + */ @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreatedAt(OffsetDateTime createdAt) { @@ -131,6 +136,11 @@ public MidServiceNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(MidServiceNotificationData data) { @@ -156,6 +166,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -181,6 +196,11 @@ public TypeEnum getType() { } + /** + * Type of notification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/RemediatingAction.java b/src/main/java/com/adyen/model/managementwebhooks/RemediatingAction.java index 9e3a2d435..f290b626a 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/RemediatingAction.java +++ b/src/main/java/com/adyen/model/managementwebhooks/RemediatingAction.java @@ -63,6 +63,11 @@ public String getCode() { } + /** + * The remediating action code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -88,6 +93,11 @@ public String getMessage() { } + /** + * A description of how you can resolve the verification error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/VerificationError.java b/src/main/java/com/adyen/model/managementwebhooks/VerificationError.java index 1077a5080..e3e194c2f 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/VerificationError.java +++ b/src/main/java/com/adyen/model/managementwebhooks/VerificationError.java @@ -116,6 +116,11 @@ public String getCode() { } + /** + * The verification error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -141,6 +146,11 @@ public String getMessage() { } + /** + * The verification error message. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -174,6 +184,11 @@ public List getRemediatingActions() { } + /** + * The actions that you can take to resolve the verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { @@ -207,6 +222,11 @@ public List getSubErrors() { } + /** + * More granular information about the verification error. + * + * @param subErrors + */ @JsonProperty(JSON_PROPERTY_SUB_ERRORS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubErrors(List subErrors) { @@ -232,6 +252,11 @@ public TypeEnum getType() { } + /** + * The type of verification error. Possible values: **invalidInput**, **dataMissing**, and **pendingStatus**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/managementwebhooks/VerificationErrorRecursive.java b/src/main/java/com/adyen/model/managementwebhooks/VerificationErrorRecursive.java index 86894004b..4ce7e509d 100644 --- a/src/main/java/com/adyen/model/managementwebhooks/VerificationErrorRecursive.java +++ b/src/main/java/com/adyen/model/managementwebhooks/VerificationErrorRecursive.java @@ -112,6 +112,11 @@ public String getCode() { } + /** + * The verification error code. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -137,6 +142,11 @@ public String getMessage() { } + /** + * The verification error message. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -162,6 +172,11 @@ public TypeEnum getType() { } + /** + * The type of verification error. Possible values: **invalidInput**, **dataMissing**, and **pendingStatus**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -195,6 +210,11 @@ public List getRemediatingActions() { } + /** + * The actions that you can take to resolve the verification error. + * + * @param remediatingActions + */ @JsonProperty(JSON_PROPERTY_REMEDIATING_ACTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemediatingActions(List remediatingActions) { diff --git a/src/main/java/com/adyen/model/payment/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/payment/AbstractOpenApiSchema.java index 566383947..6e387d8a7 100644 --- a/src/main/java/com/adyen/model/payment/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/payment/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * diff --git a/src/main/java/com/adyen/model/payment/AccountInfo.java b/src/main/java/com/adyen/model/payment/AccountInfo.java index 65f91f2f5..8bd2a3391 100644 --- a/src/main/java/com/adyen/model/payment/AccountInfo.java +++ b/src/main/java/com/adyen/model/payment/AccountInfo.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -371,6 +370,11 @@ public AccountAgeIndicatorEnum getAccountAgeIndicator() { } + /** + * Indicator for the length of time since this shopper account was created in the merchant's environment. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param accountAgeIndicator + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_AGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountAgeIndicator(AccountAgeIndicatorEnum accountAgeIndicator) { @@ -396,6 +400,11 @@ public OffsetDateTime getAccountChangeDate() { } + /** + * Date when the shopper's account was last changed. + * + * @param accountChangeDate + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_CHANGE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountChangeDate(OffsetDateTime accountChangeDate) { @@ -421,6 +430,11 @@ public AccountChangeIndicatorEnum getAccountChangeIndicator() { } + /** + * Indicator for the length of time since the shopper's account was last updated. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param accountChangeIndicator + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_CHANGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountChangeIndicator(AccountChangeIndicatorEnum accountChangeIndicator) { @@ -446,6 +460,11 @@ public OffsetDateTime getAccountCreationDate() { } + /** + * Date when the shopper's account was created. + * + * @param accountCreationDate + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountCreationDate(OffsetDateTime accountCreationDate) { @@ -471,6 +490,11 @@ public AccountTypeEnum getAccountType() { } + /** + * Indicates the type of account. For example, for a multi-account card product. Allowed values: * notApplicable * credit * debit + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -496,6 +520,11 @@ public Integer getAddCardAttemptsDay() { } + /** + * Number of attempts the shopper tried to add a card to their account in the last day. + * + * @param addCardAttemptsDay + */ @JsonProperty(JSON_PROPERTY_ADD_CARD_ATTEMPTS_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddCardAttemptsDay(Integer addCardAttemptsDay) { @@ -521,6 +550,11 @@ public OffsetDateTime getDeliveryAddressUsageDate() { } + /** + * Date the selected delivery address was first used. + * + * @param deliveryAddressUsageDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS_USAGE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddressUsageDate(OffsetDateTime deliveryAddressUsageDate) { @@ -546,6 +580,11 @@ public DeliveryAddressUsageIndicatorEnum getDeliveryAddressUsageIndicator() { } + /** + * Indicator for the length of time since this delivery address was first used. Allowed values: * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param deliveryAddressUsageIndicator + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS_USAGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddressUsageIndicator(DeliveryAddressUsageIndicatorEnum deliveryAddressUsageIndicator) { @@ -573,6 +612,11 @@ public String getHomePhone() { } + /** + * Shopper's home phone number (including the country code). + * + * @param homePhone + */ @Deprecated @JsonProperty(JSON_PROPERTY_HOME_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -601,6 +645,11 @@ public String getMobilePhone() { } + /** + * Shopper's mobile phone number (including the country code). + * + * @param mobilePhone + */ @Deprecated @JsonProperty(JSON_PROPERTY_MOBILE_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -627,6 +676,11 @@ public OffsetDateTime getPasswordChangeDate() { } + /** + * Date when the shopper last changed their password. + * + * @param passwordChangeDate + */ @JsonProperty(JSON_PROPERTY_PASSWORD_CHANGE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPasswordChangeDate(OffsetDateTime passwordChangeDate) { @@ -652,6 +706,11 @@ public PasswordChangeIndicatorEnum getPasswordChangeIndicator() { } + /** + * Indicator when the shopper has changed their password. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param passwordChangeIndicator + */ @JsonProperty(JSON_PROPERTY_PASSWORD_CHANGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPasswordChangeIndicator(PasswordChangeIndicatorEnum passwordChangeIndicator) { @@ -677,6 +736,11 @@ public Integer getPastTransactionsDay() { } + /** + * Number of all transactions (successful and abandoned) from this shopper in the past 24 hours. + * + * @param pastTransactionsDay + */ @JsonProperty(JSON_PROPERTY_PAST_TRANSACTIONS_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPastTransactionsDay(Integer pastTransactionsDay) { @@ -702,6 +766,11 @@ public Integer getPastTransactionsYear() { } + /** + * Number of all transactions (successful and abandoned) from this shopper in the past year. + * + * @param pastTransactionsYear + */ @JsonProperty(JSON_PROPERTY_PAST_TRANSACTIONS_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPastTransactionsYear(Integer pastTransactionsYear) { @@ -727,6 +796,11 @@ public OffsetDateTime getPaymentAccountAge() { } + /** + * Date this payment method was added to the shopper's account. + * + * @param paymentAccountAge + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_AGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountAge(OffsetDateTime paymentAccountAge) { @@ -752,6 +826,11 @@ public PaymentAccountIndicatorEnum getPaymentAccountIndicator() { } + /** + * Indicator for the length of time since this payment method was added to this shopper's account. Allowed values: * notApplicable * thisTransaction * lessThan30Days * from30To60Days * moreThan60Days + * + * @param paymentAccountIndicator + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountIndicator(PaymentAccountIndicatorEnum paymentAccountIndicator) { @@ -777,6 +856,11 @@ public Integer getPurchasesLast6Months() { } + /** + * Number of successful purchases in the last six months. + * + * @param purchasesLast6Months + */ @JsonProperty(JSON_PROPERTY_PURCHASES_LAST6_MONTHS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPurchasesLast6Months(Integer purchasesLast6Months) { @@ -802,6 +886,11 @@ public Boolean getSuspiciousActivity() { } + /** + * Whether suspicious activity was recorded on this account. + * + * @param suspiciousActivity + */ @JsonProperty(JSON_PROPERTY_SUSPICIOUS_ACTIVITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSuspiciousActivity(Boolean suspiciousActivity) { @@ -829,6 +918,11 @@ public String getWorkPhone() { } + /** + * Shopper's work phone number (including the country code). + * + * @param workPhone + */ @Deprecated @JsonProperty(JSON_PROPERTY_WORK_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) diff --git a/src/main/java/com/adyen/model/payment/AcctInfo.java b/src/main/java/com/adyen/model/payment/AcctInfo.java index 270c574d0..43fc301d2 100644 --- a/src/main/java/com/adyen/model/payment/AcctInfo.java +++ b/src/main/java/com/adyen/model/payment/AcctInfo.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -391,6 +390,11 @@ public ChAccAgeIndEnum getChAccAgeInd() { } + /** + * Length of time that the cardholder has had the account with the 3DS Requestor. Allowed values: * **01** — No account * **02** — Created during this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days + * + * @param chAccAgeInd + */ @JsonProperty(JSON_PROPERTY_CH_ACC_AGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccAgeInd(ChAccAgeIndEnum chAccAgeInd) { @@ -416,6 +420,11 @@ public String getChAccChange() { } + /** + * Date that the cardholder’s account with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Format: **YYYYMMDD** + * + * @param chAccChange + */ @JsonProperty(JSON_PROPERTY_CH_ACC_CHANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccChange(String chAccChange) { @@ -441,6 +450,11 @@ public ChAccChangeIndEnum getChAccChangeInd() { } + /** + * Length of time since the cardholder’s account information with the 3DS Requestor was last changed, including Billing or Shipping address, new payment account, or new user(s) added. Allowed values: * **01** — Changed during this transaction * **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60 days + * + * @param chAccChangeInd + */ @JsonProperty(JSON_PROPERTY_CH_ACC_CHANGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccChangeInd(ChAccChangeIndEnum chAccChangeInd) { @@ -466,6 +480,11 @@ public String getChAccPwChange() { } + /** + * Date that cardholder’s account with the 3DS Requestor had a password change or account reset. Format: **YYYYMMDD** + * + * @param chAccPwChange + */ @JsonProperty(JSON_PROPERTY_CH_ACC_PW_CHANGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccPwChange(String chAccPwChange) { @@ -491,6 +510,11 @@ public ChAccPwChangeIndEnum getChAccPwChangeInd() { } + /** + * Indicates the length of time since the cardholder’s account with the 3DS Requestor had a password change or account reset. Allowed values: * **01** — No change * **02** — Changed during this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days + * + * @param chAccPwChangeInd + */ @JsonProperty(JSON_PROPERTY_CH_ACC_PW_CHANGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccPwChangeInd(ChAccPwChangeIndEnum chAccPwChangeInd) { @@ -516,6 +540,11 @@ public String getChAccString() { } + /** + * Date that the cardholder opened the account with the 3DS Requestor. Format: **YYYYMMDD** + * + * @param chAccString + */ @JsonProperty(JSON_PROPERTY_CH_ACC_STRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChAccString(String chAccString) { @@ -541,6 +570,11 @@ public String getNbPurchaseAccount() { } + /** + * Number of purchases with this cardholder account during the previous six months. Max length: 4 characters. + * + * @param nbPurchaseAccount + */ @JsonProperty(JSON_PROPERTY_NB_PURCHASE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNbPurchaseAccount(String nbPurchaseAccount) { @@ -566,6 +600,11 @@ public String getPaymentAccAge() { } + /** + * String that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Format: **YYYYMMDD** + * + * @param paymentAccAge + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACC_AGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccAge(String paymentAccAge) { @@ -591,6 +630,11 @@ public PaymentAccIndEnum getPaymentAccInd() { } + /** + * Indicates the length of time that the payment account was enrolled in the cardholder’s account with the 3DS Requestor. Allowed values: * **01** — No account (guest checkout) * **02** — During this transaction * **03** — Less than 30 days * **04** — 30–60 days * **05** — More than 60 days + * + * @param paymentAccInd + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACC_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccInd(PaymentAccIndEnum paymentAccInd) { @@ -616,6 +660,11 @@ public String getProvisionAttemptsDay() { } + /** + * Number of Add Card attempts in the last 24 hours. Max length: 3 characters. + * + * @param provisionAttemptsDay + */ @JsonProperty(JSON_PROPERTY_PROVISION_ATTEMPTS_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProvisionAttemptsDay(String provisionAttemptsDay) { @@ -641,6 +690,11 @@ public String getShipAddressUsage() { } + /** + * String when the shipping address used for this transaction was first used with the 3DS Requestor. Format: **YYYYMMDD** + * + * @param shipAddressUsage + */ @JsonProperty(JSON_PROPERTY_SHIP_ADDRESS_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipAddressUsage(String shipAddressUsage) { @@ -666,6 +720,11 @@ public ShipAddressUsageIndEnum getShipAddressUsageInd() { } + /** + * Indicates when the shipping address used for this transaction was first used with the 3DS Requestor. Allowed values: * **01** — This transaction * **02** — Less than 30 days * **03** — 30–60 days * **04** — More than 60 days + * + * @param shipAddressUsageInd + */ @JsonProperty(JSON_PROPERTY_SHIP_ADDRESS_USAGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipAddressUsageInd(ShipAddressUsageIndEnum shipAddressUsageInd) { @@ -691,6 +750,11 @@ public ShipNameIndicatorEnum getShipNameIndicator() { } + /** + * Indicates if the Cardholder Name on the account is identical to the shipping Name used for this transaction. Allowed values: * **01** — Account Name identical to shipping Name * **02** — Account Name different to shipping Name + * + * @param shipNameIndicator + */ @JsonProperty(JSON_PROPERTY_SHIP_NAME_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipNameIndicator(ShipNameIndicatorEnum shipNameIndicator) { @@ -716,6 +780,11 @@ public SuspiciousAccActivityEnum getSuspiciousAccActivity() { } + /** + * Indicates whether the 3DS Requestor has experienced suspicious activity (including previous fraud) on the cardholder account. Allowed values: * **01** — No suspicious activity has been observed * **02** — Suspicious activity has been observed + * + * @param suspiciousAccActivity + */ @JsonProperty(JSON_PROPERTY_SUSPICIOUS_ACC_ACTIVITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSuspiciousAccActivity(SuspiciousAccActivityEnum suspiciousAccActivity) { @@ -741,6 +810,11 @@ public String getTxnActivityDay() { } + /** + * Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous 24 hours. Max length: 3 characters. + * + * @param txnActivityDay + */ @JsonProperty(JSON_PROPERTY_TXN_ACTIVITY_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxnActivityDay(String txnActivityDay) { @@ -766,6 +840,11 @@ public String getTxnActivityYear() { } + /** + * Number of transactions (successful and abandoned) for this cardholder account with the 3DS Requestor across all payment accounts in the previous year. Max length: 3 characters. + * + * @param txnActivityYear + */ @JsonProperty(JSON_PROPERTY_TXN_ACTIVITY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTxnActivityYear(String txnActivityYear) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalData3DSecure.java b/src/main/java/com/adyen/model/payment/AdditionalData3DSecure.java index 314208b0e..e409f3fdc 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalData3DSecure.java +++ b/src/main/java/com/adyen/model/payment/AdditionalData3DSecure.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -121,6 +120,11 @@ public String getAllow3DS2() { } + /** + * Indicates if you are able to process 3D Secure 2 transactions natively on your payment page. Send this parameter when you are using `/payments` endpoint with any of our [native 3D Secure 2 solutions](https://docs.adyen.com/online-payments/3d-secure/native-3ds2). > This parameter only indicates readiness to support native 3D Secure 2 authentication. To specify if you _want_ to perform 3D Secure, use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) or send the `executeThreeD` parameter. Possible values: * **true** - Ready to support native 3D Secure 2 authentication. Setting this to true does not mean always applying 3D Secure 2. Adyen still selects the version of 3D Secure based on configuration to optimize authorisation rates and improve the shopper's experience. * **false** – Not ready to support native 3D Secure 2 authentication. Adyen will not offer 3D Secure 2 to your shopper regardless of your configuration. + * + * @param allow3DS2 + */ @JsonProperty(JSON_PROPERTY_ALLOW3_D_S2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllow3DS2(String allow3DS2) { @@ -146,6 +150,11 @@ public ChallengeWindowSizeEnum getChallengeWindowSize() { } + /** + * Dimensions of the 3DS2 challenge window to be displayed to the cardholder. Possible values: * **01** - size of 250x400 * **02** - size of 390x400 * **03** - size of 500x600 * **04** - size of 600x400 * **05** - Fullscreen + * + * @param challengeWindowSize + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_WINDOW_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeWindowSize(ChallengeWindowSizeEnum challengeWindowSize) { @@ -171,6 +180,11 @@ public String getExecuteThreeD() { } + /** + * Indicates if you want to perform 3D Secure authentication on a transaction. > Alternatively, you can use [Dynamic 3D Secure](/risk-management/dynamic-3d-secure) to configure rules for applying 3D Secure. Possible values: * **true** – Perform 3D Secure authentication. * **false** – Don't perform 3D Secure authentication. Note that this setting results in refusals if the issuer mandates 3D Secure because of the PSD2 directive or other, national regulations. + * + * @param executeThreeD + */ @JsonProperty(JSON_PROPERTY_EXECUTE_THREE_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExecuteThreeD(String executeThreeD) { @@ -196,6 +210,11 @@ public String getMpiImplementationType() { } + /** + * In case of Secure+, this field must be set to **CUPSecurePlus**. + * + * @param mpiImplementationType + */ @JsonProperty(JSON_PROPERTY_MPI_IMPLEMENTATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiImplementationType(String mpiImplementationType) { @@ -221,6 +240,11 @@ public String getScaExemption() { } + /** + * Indicates the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that you want to request for the transaction. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + * + * @param scaExemption + */ @JsonProperty(JSON_PROPERTY_SCA_EXEMPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScaExemption(String scaExemption) { @@ -246,6 +270,11 @@ public String getThreeDSVersion() { } + /** + * Indicates your preference for the 3D Secure version. > If you use this parameter, you override the checks from Adyen's Authentication Engine. We recommend to use this field only if you have an extensive knowledge of 3D Secure. Possible values: * **1.0.2**: Apply 3D Secure version 1.0.2. * **2.1.0**: Apply 3D Secure version 2.1.0. * **2.2.0**: Apply 3D Secure version 2.2.0. If the issuer does not support version 2.2.0, we will fall back to 2.1.0. The following rules apply: * If you prefer 2.1.0 or 2.2.0 but we receive a negative `transStatus` in the `ARes`, we will apply the fallback policy configured in your account. For example, if the configuration is to fall back to 3D Secure 1, we will apply version 1.0.2. * If you prefer 2.1.0 or 2.2.0 but the BIN is not enrolled, you will receive an error. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataAirline.java b/src/main/java/com/adyen/model/payment/AdditionalDataAirline.java index 2c3ce18f9..b1d09fb45 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataAirline.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataAirline.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -168,6 +167,11 @@ public String getAirlineAgencyInvoiceNumber() { } + /** + * The reference number for the invoice, issued by the agency. * Encoding: ASCII * minLength: 1 character * maxLength: 6 characters + * + * @param airlineAgencyInvoiceNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AGENCY_INVOICE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAgencyInvoiceNumber(String airlineAgencyInvoiceNumber) { @@ -193,6 +197,11 @@ public String getAirlineAgencyPlanName() { } + /** + * The two-letter agency plan identifier. * Encoding: ASCII * minLength: 2 characters * maxLength: 2 characters + * + * @param airlineAgencyPlanName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AGENCY_PLAN_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAgencyPlanName(String airlineAgencyPlanName) { @@ -218,6 +227,11 @@ public String getAirlineAirlineCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-digit accounting code (PAX) that identifies the carrier. * Format: IATA 3-digit accounting code (PAX) * Example: KLM = 074 * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineAirlineCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AIRLINE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAirlineCode(String airlineAirlineCode) { @@ -243,6 +257,11 @@ public String getAirlineAirlineDesignatorCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. * Encoding: ASCII * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineAirlineDesignatorCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_AIRLINE_DESIGNATOR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineAirlineDesignatorCode(String airlineAirlineDesignatorCode) { @@ -268,6 +287,11 @@ public String getAirlineBoardingFee() { } + /** + * The amount charged for boarding the plane, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 character * maxLength: 18 characters + * + * @param airlineBoardingFee + */ @JsonProperty(JSON_PROPERTY_AIRLINE_BOARDING_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineBoardingFee(String airlineBoardingFee) { @@ -293,6 +317,11 @@ public String getAirlineComputerizedReservationSystem() { } + /** + * The [CRS](https://en.wikipedia.org/wiki/Computer_reservation_system) used to make the reservation and purchase the ticket. * Encoding: ASCII * minLength: 4 characters * maxLength: 4 characters + * + * @param airlineComputerizedReservationSystem + */ @JsonProperty(JSON_PROPERTY_AIRLINE_COMPUTERIZED_RESERVATION_SYSTEM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineComputerizedReservationSystem(String airlineComputerizedReservationSystem) { @@ -318,6 +347,11 @@ public String getAirlineCustomerReferenceNumber() { } + /** + * The alphanumeric customer reference number. * Encoding: ASCII * maxLength: 20 characters * If you send more than 20 characters, the customer reference number is truncated * Must not be all spaces + * + * @param airlineCustomerReferenceNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_CUSTOMER_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineCustomerReferenceNumber(String airlineCustomerReferenceNumber) { @@ -343,6 +377,11 @@ public String getAirlineDocumentType() { } + /** + * A code that identifies the type of item bought. The description of the code can appear on credit card statements. * Encoding: ASCII * Example: Passenger ticket = 01 * minLength: 2 characters * maxLength: 2 characters + * + * @param airlineDocumentType + */ @JsonProperty(JSON_PROPERTY_AIRLINE_DOCUMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineDocumentType(String airlineDocumentType) { @@ -368,6 +407,11 @@ public String getAirlineFlightDate() { } + /** + * The flight departure date. Local time `(HH:mm)` is optional. * Date format: `yyyy-MM-dd` * Date and time format: `yyyy-MM-dd HH:mm` * minLength: 10 characters * maxLength: 16 characters + * + * @param airlineFlightDate + */ @JsonProperty(JSON_PROPERTY_AIRLINE_FLIGHT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineFlightDate(String airlineFlightDate) { @@ -393,6 +437,11 @@ public String getAirlineLegCarrierCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 2-letter accounting code (PAX) that identifies the carrier. This field is required if the airline data includes leg details. * Example: KLM = KL * minLength: 2 characters * maxLength: 2 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegCarrierCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_CARRIER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegCarrierCode(String airlineLegCarrierCode) { @@ -418,6 +467,11 @@ public String getAirlineLegClassOfTravel() { } + /** + * A one-letter travel class identifier. The following are common: * F: first class * J: business class * Y: economy class * W: premium economy * Encoding: ASCII * minLength: 1 character * maxLength: 1 character * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegClassOfTravel + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_CLASS_OF_TRAVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegClassOfTravel(String airlineLegClassOfTravel) { @@ -443,6 +497,11 @@ public String getAirlineLegDateOfTravel() { } + /** + * Date and time of travel in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format `yyyy-MM-dd HH:mm`. * Encoding: ASCII * minLength: 16 characters * maxLength: 16 characters + * + * @param airlineLegDateOfTravel + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DATE_OF_TRAVEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDateOfTravel(String airlineLegDateOfTravel) { @@ -468,6 +527,11 @@ public String getAirlineLegDepartAirport() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) three-letter airport code of the departure airport. This field is required if the airline data includes leg details. * Encoding: ASCII * Example: Amsterdam = AMS * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegDepartAirport + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DEPART_AIRPORT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDepartAirport(String airlineLegDepartAirport) { @@ -493,6 +557,11 @@ public String getAirlineLegDepartTax() { } + /** + * The amount of [departure tax](https://en.wikipedia.org/wiki/Departure_tax) charged, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Encoding: Numeric * minLength: 1 * maxLength: 12 *Must not be all zeros. + * + * @param airlineLegDepartTax + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DEPART_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDepartTax(String airlineLegDepartTax) { @@ -518,6 +587,11 @@ public String getAirlineLegDestinationCode() { } + /** + * The [IATA](https://www.iata.org/services/pages/codes.aspx) 3-letter airport code of the destination airport. This field is required if the airline data includes leg details. * Example: Amsterdam = AMS * Encoding: ASCII * minLength: 3 characters * maxLength: 3 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegDestinationCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_DESTINATION_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegDestinationCode(String airlineLegDestinationCode) { @@ -543,6 +617,11 @@ public String getAirlineLegFareBaseCode() { } + /** + * The [fare basis code](https://en.wikipedia.org/wiki/Fare_basis_code), alphanumeric. * minLength: 1 character * maxLength: 6 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegFareBaseCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_FARE_BASE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegFareBaseCode(String airlineLegFareBaseCode) { @@ -568,6 +647,11 @@ public String getAirlineLegFlightNumber() { } + /** + * The flight identifier. * minLength: 1 character * maxLength: 5 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineLegFlightNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_FLIGHT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegFlightNumber(String airlineLegFlightNumber) { @@ -593,6 +677,11 @@ public String getAirlineLegStopOverCode() { } + /** + * A one-letter code that indicates whether the passenger is entitled to make a stopover. Can be a space, O if the passenger is entitled to make a stopover, or X if they are not. * Encoding: ASCII * minLength: 1 character * maxLength: 1 character + * + * @param airlineLegStopOverCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_LEG_STOP_OVER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineLegStopOverCode(String airlineLegStopOverCode) { @@ -618,6 +707,11 @@ public String getAirlinePassengerDateOfBirth() { } + /** + * The passenger's date of birth. Date format: `yyyy-MM-dd` * minLength: 10 * maxLength: 10 + * + * @param airlinePassengerDateOfBirth + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerDateOfBirth(String airlinePassengerDateOfBirth) { @@ -643,6 +737,11 @@ public String getAirlinePassengerFirstName() { } + /** + * The passenger's first name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII + * + * @param airlinePassengerFirstName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerFirstName(String airlinePassengerFirstName) { @@ -668,6 +767,11 @@ public String getAirlinePassengerLastName() { } + /** + * The passenger's last name. > This field is required if the airline data includes passenger details or leg details. * Encoding: ASCII + * + * @param airlinePassengerLastName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerLastName(String airlinePassengerLastName) { @@ -693,6 +797,11 @@ public String getAirlinePassengerTelephoneNumber() { } + /** + * The passenger's telephone number, including country code. This is an alphanumeric field that can include the '+' and '-' signs. * Encoding: ASCII * minLength: 3 characters * maxLength: 30 characters + * + * @param airlinePassengerTelephoneNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerTelephoneNumber(String airlinePassengerTelephoneNumber) { @@ -718,6 +827,11 @@ public String getAirlinePassengerTravellerType() { } + /** + * The IATA passenger type code (PTC). * Encoding: ASCII * minLength: 3 characters * maxLength: 6 characters + * + * @param airlinePassengerTravellerType + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_TRAVELLER_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerTravellerType(String airlinePassengerTravellerType) { @@ -743,6 +857,11 @@ public String getAirlinePassengerName() { } + /** + * The passenger's name, initials, and title. * Format: last name + first name or initials + title * Example: *FLYER / MARY MS* * minLength: 1 character * maxLength: 20 characters * If you send more than 20 characters, the name is truncated * Must not be all spaces *Must not be all zeros. + * + * @param airlinePassengerName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_PASSENGER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlinePassengerName(String airlinePassengerName) { @@ -768,6 +887,11 @@ public String getAirlineTicketIssueAddress() { } + /** + * The address of the organization that issued the ticket. * minLength: 0 characters * maxLength: 16 characters + * + * @param airlineTicketIssueAddress + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TICKET_ISSUE_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTicketIssueAddress(String airlineTicketIssueAddress) { @@ -793,6 +917,11 @@ public String getAirlineTicketNumber() { } + /** + * The ticket's unique identifier. * minLength: 1 character * maxLength: 15 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineTicketNumber + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TICKET_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTicketNumber(String airlineTicketNumber) { @@ -818,6 +947,11 @@ public String getAirlineTravelAgencyCode() { } + /** + * The unique identifier from IATA or ARC for the travel agency that issues the ticket. * Encoding: ASCII * minLength: 1 character * maxLength: 8 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineTravelAgencyCode + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TRAVEL_AGENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTravelAgencyCode(String airlineTravelAgencyCode) { @@ -843,6 +977,11 @@ public String getAirlineTravelAgencyName() { } + /** + * The name of the travel agency. * Encoding: ASCII * minLength: 1 character * maxLength: 25 characters * Must not be all spaces *Must not be all zeros. + * + * @param airlineTravelAgencyName + */ @JsonProperty(JSON_PROPERTY_AIRLINE_TRAVEL_AGENCY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAirlineTravelAgencyName(String airlineTravelAgencyName) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataCarRental.java b/src/main/java/com/adyen/model/payment/AdditionalDataCarRental.java index a29d90e9a..14b8dbf21 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataCarRental.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataCarRental.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -148,6 +147,11 @@ public String getCarRentalCheckOutDate() { } + /** + * The pick-up date. * Date format: `yyyyMMdd` + * + * @param carRentalCheckOutDate + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_CHECK_OUT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalCheckOutDate(String carRentalCheckOutDate) { @@ -173,6 +177,11 @@ public String getCarRentalCustomerServiceTollFreeNumber() { } + /** + * The customer service phone number of the car rental company. * Format: Alphanumeric * maxLength: 17 * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros. + * + * @param carRentalCustomerServiceTollFreeNumber + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_CUSTOMER_SERVICE_TOLL_FREE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalCustomerServiceTollFreeNumber(String carRentalCustomerServiceTollFreeNumber) { @@ -198,6 +207,11 @@ public String getCarRentalDaysRented() { } + /** + * Number of days for which the car is being rented. * Format: Numeric * maxLength: 4 * Must not be all spaces + * + * @param carRentalDaysRented + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_DAYS_RENTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalDaysRented(String carRentalDaysRented) { @@ -223,6 +237,11 @@ public String getCarRentalFuelCharges() { } + /** + * Any fuel charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12 + * + * @param carRentalFuelCharges + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_FUEL_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalFuelCharges(String carRentalFuelCharges) { @@ -248,6 +267,11 @@ public String getCarRentalInsuranceCharges() { } + /** + * Any insurance charges associated with the rental, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Numeric * maxLength: 12 * Must not be all spaces *Must not be all zeros. + * + * @param carRentalInsuranceCharges + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_INSURANCE_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalInsuranceCharges(String carRentalInsuranceCharges) { @@ -273,6 +297,11 @@ public String getCarRentalLocationCity() { } + /** + * The city where the car is rented. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalLocationCity + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_LOCATION_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalLocationCity(String carRentalLocationCity) { @@ -298,6 +327,11 @@ public String getCarRentalLocationCountry() { } + /** + * The country where the car is rented, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2 + * + * @param carRentalLocationCountry + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_LOCATION_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalLocationCountry(String carRentalLocationCountry) { @@ -323,6 +357,11 @@ public String getCarRentalLocationStateProvince() { } + /** + * The state or province where the car is rented. * Format: Alphanumeric * maxLength: 2 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalLocationStateProvince + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_LOCATION_STATE_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalLocationStateProvince(String carRentalLocationStateProvince) { @@ -348,6 +387,11 @@ public String getCarRentalNoShowIndicator() { } + /** + * Indicates if the customer didn't pick up their rental car. * Y - Customer did not pick up their car * N - Not applicable + * + * @param carRentalNoShowIndicator + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_NO_SHOW_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalNoShowIndicator(String carRentalNoShowIndicator) { @@ -373,6 +417,11 @@ public String getCarRentalOneWayDropOffCharges() { } + /** + * The charge for not returning a car to the original rental location, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 12 + * + * @param carRentalOneWayDropOffCharges + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_ONE_WAY_DROP_OFF_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalOneWayDropOffCharges(String carRentalOneWayDropOffCharges) { @@ -398,6 +447,11 @@ public String getCarRentalRate() { } + /** + * The daily rental rate, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: Alphanumeric * maxLength: 12 + * + * @param carRentalRate + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRate(String carRentalRate) { @@ -423,6 +477,11 @@ public String getCarRentalRateIndicator() { } + /** + * Specifies whether the given rate is applied daily or weekly. * D - Daily rate * W - Weekly rate + * + * @param carRentalRateIndicator + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RATE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRateIndicator(String carRentalRateIndicator) { @@ -448,6 +507,11 @@ public String getCarRentalRentalAgreementNumber() { } + /** + * The rental agreement number for the car rental. * Format: Alphanumeric * maxLength: 9 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalRentalAgreementNumber + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RENTAL_AGREEMENT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRentalAgreementNumber(String carRentalRentalAgreementNumber) { @@ -473,6 +537,11 @@ public String getCarRentalRentalClassId() { } + /** + * The classification of the rental car. * Format: Alphanumeric * maxLength: 4 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalRentalClassId + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RENTAL_CLASS_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRentalClassId(String carRentalRentalClassId) { @@ -498,6 +567,11 @@ public String getCarRentalRenterName() { } + /** + * The name of the person renting the car. * Format: Alphanumeric * maxLength: 26 * If you send more than 26 characters, the name is truncated * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalRenterName + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RENTER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalRenterName(String carRentalRenterName) { @@ -523,6 +597,11 @@ public String getCarRentalReturnCity() { } + /** + * The city where the car must be returned. * Format: Alphanumeric * maxLength: 18 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalReturnCity + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnCity(String carRentalReturnCity) { @@ -548,6 +627,11 @@ public String getCarRentalReturnCountry() { } + /** + * The country where the car must be returned, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. * Format: Alphanumeric * maxLength: 2 + * + * @param carRentalReturnCountry + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnCountry(String carRentalReturnCountry) { @@ -573,6 +657,11 @@ public String getCarRentalReturnDate() { } + /** + * The last date to return the car by. * Date format: `yyyyMMdd` * maxLength: 8 + * + * @param carRentalReturnDate + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnDate(String carRentalReturnDate) { @@ -598,6 +687,11 @@ public String getCarRentalReturnLocationId() { } + /** + * The agency code, phone number, or address abbreviation * Format: Alphanumeric * maxLength: 10 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalReturnLocationId + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnLocationId(String carRentalReturnLocationId) { @@ -623,6 +717,11 @@ public String getCarRentalReturnStateProvince() { } + /** + * The state or province where the car must be returned. * Format: Alphanumeric * maxLength: 3 * Must not start with a space or be all spaces *Must not be all zeros. + * + * @param carRentalReturnStateProvince + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_RETURN_STATE_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalReturnStateProvince(String carRentalReturnStateProvince) { @@ -648,6 +747,11 @@ public String getCarRentalTaxExemptIndicator() { } + /** + * Indicates if the goods or services were tax-exempt, or if tax was not paid on them. Values: * Y - Goods or services were tax exempt * N - Tax was not collected + * + * @param carRentalTaxExemptIndicator + */ @JsonProperty(JSON_PROPERTY_CAR_RENTAL_TAX_EXEMPT_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCarRentalTaxExemptIndicator(String carRentalTaxExemptIndicator) { @@ -673,6 +777,11 @@ public String getTravelEntertainmentAuthDataDuration() { } + /** + * Number of days the car is rented for. This should be included in the auth message. * Format: Numeric * maxLength: 4 + * + * @param travelEntertainmentAuthDataDuration + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_DURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataDuration(String travelEntertainmentAuthDataDuration) { @@ -698,6 +807,11 @@ public String getTravelEntertainmentAuthDataMarket() { } + /** + * Indicates what market-specific dataset will be submitted or is being submitted. Value should be 'A' for car rental. This should be included in the auth message. * Format: Alphanumeric * maxLength: 1 + * + * @param travelEntertainmentAuthDataMarket + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_MARKET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataMarket(String travelEntertainmentAuthDataMarket) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataCommon.java b/src/main/java/com/adyen/model/payment/AdditionalDataCommon.java index 96f1c9df1..742a47950 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataCommon.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataCommon.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -155,6 +154,11 @@ public String getRequestedTestErrorResponseCode() { } + /** + * Triggers test scenarios that allow to replicate certain communication errors. Allowed values: * **NO_CONNECTION_AVAILABLE** – There wasn't a connection available to service the outgoing communication. This is a transient, retriable error since no messaging could be initiated to an issuing system (or third-party acquiring system). Therefore, the header Transient-Error: true is returned in the response. A subsequent request using the same idempotency key will be processed as if it was the first request. * **IOEXCEPTION_RECEIVED** – Something went wrong during transmission of the message or receiving the response. This is a classified as non-transient because the message could have been received by the issuing party and been acted upon. No transient error header is returned. If using idempotency, the (error) response is stored as the final result for the idempotency key. Subsequent messages with the same idempotency key not be processed beyond returning the stored response. + * + * @param requestedTestErrorResponseCode + */ @JsonProperty(JSON_PROPERTY_REQUESTED_TEST_ERROR_RESPONSE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestedTestErrorResponseCode(String requestedTestErrorResponseCode) { @@ -180,6 +184,11 @@ public String getAllowPartialAuth() { } + /** + * Set to true to authorise a part of the requested amount in case the cardholder does not have enough funds on their account. If a payment was partially authorised, the response includes resultCode: PartiallyAuthorised and the authorised amount in additionalData.authorisedAmountValue. To enable this functionality, contact our Support Team. + * + * @param allowPartialAuth + */ @JsonProperty(JSON_PROPERTY_ALLOW_PARTIAL_AUTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllowPartialAuth(String allowPartialAuth) { @@ -205,6 +214,11 @@ public String getAuthorisationType() { } + /** + * Flags a card payment request for either pre-authorisation or final authorisation. For more information, refer to [Authorisation types](https://docs.adyen.com/online-payments/adjust-authorisation#authorisation-types). Allowed values: * **PreAuth** – flags the payment request to be handled as a pre-authorisation. * **FinalAuth** – flags the payment request to be handled as a final authorisation. + * + * @param authorisationType + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationType(String authorisationType) { @@ -230,6 +244,11 @@ public String getCustomRoutingFlag() { } + /** + * Allows you to determine or override the acquirer account that should be used for the transaction. If you need to process a payment with an acquirer different from a default one, you can set up a corresponding configuration on the Adyen payments platform. Then you can pass a custom routing flag in a payment request's additional data to target a specific acquirer. To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param customRoutingFlag + */ @JsonProperty(JSON_PROPERTY_CUSTOM_ROUTING_FLAG) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCustomRoutingFlag(String customRoutingFlag) { @@ -255,6 +274,11 @@ public IndustryUsageEnum getIndustryUsage() { } + /** + * In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made. Possible values: * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation. * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed. + * + * @param industryUsage + */ @JsonProperty(JSON_PROPERTY_INDUSTRY_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIndustryUsage(IndustryUsageEnum industryUsage) { @@ -280,6 +304,11 @@ public String getManualCapture() { } + /** + * Set to **true** to require [manual capture](https://docs.adyen.com/online-payments/capture) for the transaction. + * + * @param manualCapture + */ @JsonProperty(JSON_PROPERTY_MANUAL_CAPTURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setManualCapture(String manualCapture) { @@ -305,6 +334,11 @@ public String getNetworkTxReference() { } + /** + * Allows you to link the transaction to the original or previous one in a subscription/card-on-file chain. This field is required for token-based transactions where Adyen does not tokenize the card. Transaction identifier from card schemes, for example, Mastercard Trace ID or the Visa Transaction ID. Submit the original transaction ID of the contract in your payment request if you are not tokenizing card details with Adyen and are making a merchant-initiated transaction (MIT) for subsequent charges. Make sure you are sending `shopperInteraction` **ContAuth** and `recurringProcessingModel` **Subscription** or **UnscheduledCardOnFile** to ensure that the transaction is classified as MIT. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -330,6 +364,11 @@ public String getOverwriteBrand() { } + /** + * Boolean indicator that can be optionally used for performing debit transactions on combo cards (for example, combo cards in Brazil). This is not mandatory but we recommend that you set this to true if you want to use the `selectedBrand` value to specify how to process the transaction. + * + * @param overwriteBrand + */ @JsonProperty(JSON_PROPERTY_OVERWRITE_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOverwriteBrand(String overwriteBrand) { @@ -355,6 +394,11 @@ public String getSubMerchantCity() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the city of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 13 characters. + * + * @param subMerchantCity + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantCity(String subMerchantCity) { @@ -380,6 +424,11 @@ public String getSubMerchantCountry() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the three-letter country code of the actual merchant's address. * Format: alpha-numeric. * Fixed length: 3 characters. + * + * @param subMerchantCountry + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantCountry(String subMerchantCountry) { @@ -405,6 +454,11 @@ public String getSubMerchantID() { } + /** + * This field contains an identifier of the actual merchant when a transaction is submitted via a payment facilitator. The payment facilitator must send in this unique ID. A unique identifier per submerchant that is required if the transaction is performed by a registered payment facilitator. * Format: alpha-numeric. * Fixed length: 15 characters. + * + * @param subMerchantID + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantID(String subMerchantID) { @@ -430,6 +484,11 @@ public String getSubMerchantName() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the name of the actual merchant. * Format: alpha-numeric. * Maximum length: 22 characters. + * + * @param subMerchantName + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantName(String subMerchantName) { @@ -455,6 +514,11 @@ public String getSubMerchantPostalCode() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the postal code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 10 characters. + * + * @param subMerchantPostalCode + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantPostalCode(String subMerchantPostalCode) { @@ -480,6 +544,11 @@ public String getSubMerchantState() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator, and if applicable to the country. This field must contain the state code of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 3 characters. + * + * @param subMerchantState + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantState(String subMerchantState) { @@ -505,6 +574,11 @@ public String getSubMerchantStreet() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the street of the actual merchant's address. * Format: alpha-numeric. * Maximum length: 60 characters. + * + * @param subMerchantStreet + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantStreet(String subMerchantStreet) { @@ -530,6 +604,11 @@ public String getSubMerchantTaxId() { } + /** + * This field is required if the transaction is performed by a registered payment facilitator. This field must contain the tax ID of the actual merchant. * Format: alpha-numeric. * Fixed length: 11 or 14 characters. + * + * @param subMerchantTaxId + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantTaxId(String subMerchantTaxId) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataLevel23.java b/src/main/java/com/adyen/model/payment/AdditionalDataLevel23.java index 2458f809e..6b1fea5df 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataLevel23.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataLevel23.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -124,6 +123,11 @@ public String getEnhancedSchemeDataCustomerReference() { } + /** + * The customer code. * Encoding: ASCII * Max length: 25 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataCustomerReference + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_CUSTOMER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataCustomerReference(String enhancedSchemeDataCustomerReference) { @@ -149,6 +153,11 @@ public String getEnhancedSchemeDataDestinationCountryCode() { } + /** + * The three-letter [ISO 3166-1 alpha-3 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) for the destination address. * Encoding: ASCII * Fixed length: 3 characters + * + * @param enhancedSchemeDataDestinationCountryCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DESTINATION_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDestinationCountryCode(String enhancedSchemeDataDestinationCountryCode) { @@ -174,6 +183,11 @@ public String getEnhancedSchemeDataDestinationPostalCode() { } + /** + * The postal code of the destination address. * Encoding: ASCII * Max length: 10 characters * Must not start with a space + * + * @param enhancedSchemeDataDestinationPostalCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DESTINATION_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDestinationPostalCode(String enhancedSchemeDataDestinationPostalCode) { @@ -199,6 +213,11 @@ public String getEnhancedSchemeDataDestinationStateProvinceCode() { } + /** + * Destination state or province code. * Encoding: ASCII * Max length: 3 characters * Must not start with a space + * + * @param enhancedSchemeDataDestinationStateProvinceCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DESTINATION_STATE_PROVINCE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDestinationStateProvinceCode(String enhancedSchemeDataDestinationStateProvinceCode) { @@ -224,6 +243,11 @@ public String getEnhancedSchemeDataDutyAmount() { } + /** + * The duty amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters + * + * @param enhancedSchemeDataDutyAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_DUTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataDutyAmount(String enhancedSchemeDataDutyAmount) { @@ -249,6 +273,11 @@ public String getEnhancedSchemeDataFreightAmount() { } + /** + * The shipping amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric *Max length: 12 characters + * + * @param enhancedSchemeDataFreightAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_FREIGHT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataFreightAmount(String enhancedSchemeDataFreightAmount) { @@ -274,6 +303,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrCommodityCode() { } + /** + * The [UNSPC commodity code](https://www.unspsc.org/) of the item. * Encoding: ASCII * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrCommodityCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_COMMODITY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrCommodityCode(String enhancedSchemeDataItemDetailLineItemNrCommodityCode) { @@ -299,6 +333,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrDescription() { } + /** + * A description of the item. * Encoding: ASCII * Max length: 26 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrDescription + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrDescription(String enhancedSchemeDataItemDetailLineItemNrDescription) { @@ -324,6 +363,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrDiscountAmount() { } + /** + * The discount amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters + * + * @param enhancedSchemeDataItemDetailLineItemNrDiscountAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_DISCOUNT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrDiscountAmount(String enhancedSchemeDataItemDetailLineItemNrDiscountAmount) { @@ -349,6 +393,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrProductCode() { } + /** + * The product code. * Encoding: ASCII. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrProductCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_PRODUCT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrProductCode(String enhancedSchemeDataItemDetailLineItemNrProductCode) { @@ -374,6 +423,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrQuantity() { } + /** + * The number of items. Must be an integer greater than zero. * Encoding: Numeric * Max length: 12 characters * Must not start with a space or be all spaces + * + * @param enhancedSchemeDataItemDetailLineItemNrQuantity + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_QUANTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrQuantity(String enhancedSchemeDataItemDetailLineItemNrQuantity) { @@ -399,6 +453,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrTotalAmount() { } + /** + * The total amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Max length: 12 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrTotalAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_TOTAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrTotalAmount(String enhancedSchemeDataItemDetailLineItemNrTotalAmount) { @@ -424,6 +483,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrUnitOfMeasure() { } + /** + * The unit of measurement for an item. * Encoding: ASCII Max length: 3 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrUnitOfMeasure + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_UNIT_OF_MEASURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrUnitOfMeasure(String enhancedSchemeDataItemDetailLineItemNrUnitOfMeasure) { @@ -449,6 +513,11 @@ public String getEnhancedSchemeDataItemDetailLineItemNrUnitPrice() { } + /** + * The unit price in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. * Encoding: Numeric * Max length: 12 characters * Must not be all zeros. + * + * @param enhancedSchemeDataItemDetailLineItemNrUnitPrice + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ITEM_DETAIL_LINE_ITEM_NR_UNIT_PRICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataItemDetailLineItemNrUnitPrice(String enhancedSchemeDataItemDetailLineItemNrUnitPrice) { @@ -474,6 +543,11 @@ public String getEnhancedSchemeDataOrderDate() { } + /** + * The order date. * Format: `ddMMyy` * Encoding: ASCII * Max length: 6 characters + * + * @param enhancedSchemeDataOrderDate + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_ORDER_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataOrderDate(String enhancedSchemeDataOrderDate) { @@ -499,6 +573,11 @@ public String getEnhancedSchemeDataShipFromPostalCode() { } + /** + * The postal code of the address the item is shipped from. * Encoding: ASCII * Max length: 10 characters * Must not start with a space or be all spaces * Must not be all zeros. + * + * @param enhancedSchemeDataShipFromPostalCode + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_SHIP_FROM_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataShipFromPostalCode(String enhancedSchemeDataShipFromPostalCode) { @@ -524,6 +603,11 @@ public String getEnhancedSchemeDataTotalTaxAmount() { } + /** + * The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * For example, 2000 means USD 20.00. *Encoding: Numeric *Max length: 12 characters * Must not be all zeros. + * + * @param enhancedSchemeDataTotalTaxAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TOTAL_TAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTotalTaxAmount(String enhancedSchemeDataTotalTaxAmount) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataLodging.java b/src/main/java/com/adyen/model/payment/AdditionalDataLodging.java index 9b2a38693..12febe380 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataLodging.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataLodging.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -120,6 +119,11 @@ public String getLodgingCheckInDate() { } + /** + * The arrival date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**. + * + * @param lodgingCheckInDate + */ @JsonProperty(JSON_PROPERTY_LODGING_CHECK_IN_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingCheckInDate(String lodgingCheckInDate) { @@ -145,6 +149,11 @@ public String getLodgingCheckOutDate() { } + /** + * The departure date. * Date format: **yyyyMmDd**. For example, for 2023 April 22, **20230422**. + * + * @param lodgingCheckOutDate + */ @JsonProperty(JSON_PROPERTY_LODGING_CHECK_OUT_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingCheckOutDate(String lodgingCheckOutDate) { @@ -170,6 +179,11 @@ public String getLodgingCustomerServiceTollFreeNumber() { } + /** + * The toll-free phone number for the lodging. * Format: numeric * Max length: 17 characters. * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros. + * + * @param lodgingCustomerServiceTollFreeNumber + */ @JsonProperty(JSON_PROPERTY_LODGING_CUSTOMER_SERVICE_TOLL_FREE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingCustomerServiceTollFreeNumber(String lodgingCustomerServiceTollFreeNumber) { @@ -195,6 +209,11 @@ public String getLodgingFireSafetyActIndicator() { } + /** + * Identifies that the facility complies with the Hotel and Motel Fire Safety Act of 1990. Must be 'Y' or 'N'. * Format: alphabetic * Max length: 1 character + * + * @param lodgingFireSafetyActIndicator + */ @JsonProperty(JSON_PROPERTY_LODGING_FIRE_SAFETY_ACT_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFireSafetyActIndicator(String lodgingFireSafetyActIndicator) { @@ -220,6 +239,11 @@ public String getLodgingFolioCashAdvances() { } + /** + * The folio cash advances, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters + * + * @param lodgingFolioCashAdvances + */ @JsonProperty(JSON_PROPERTY_LODGING_FOLIO_CASH_ADVANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFolioCashAdvances(String lodgingFolioCashAdvances) { @@ -245,6 +269,11 @@ public String getLodgingFolioNumber() { } + /** + * The card acceptor’s internal invoice or billing ID reference number. * Max length: 25 characters. * Must not start with a space *Must not be all zeros. + * + * @param lodgingFolioNumber + */ @JsonProperty(JSON_PROPERTY_LODGING_FOLIO_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFolioNumber(String lodgingFolioNumber) { @@ -270,6 +299,11 @@ public String getLodgingFoodBeverageCharges() { } + /** + * Any charges for food and beverages associated with the booking, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters + * + * @param lodgingFoodBeverageCharges + */ @JsonProperty(JSON_PROPERTY_LODGING_FOOD_BEVERAGE_CHARGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingFoodBeverageCharges(String lodgingFoodBeverageCharges) { @@ -295,6 +329,11 @@ public String getLodgingNoShowIndicator() { } + /** + * Indicates if the customer didn't check in for their booking. Possible values: * **Y**: the customer didn't check in * **N**: the customer checked in + * + * @param lodgingNoShowIndicator + */ @JsonProperty(JSON_PROPERTY_LODGING_NO_SHOW_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingNoShowIndicator(String lodgingNoShowIndicator) { @@ -320,6 +359,11 @@ public String getLodgingPrepaidExpenses() { } + /** + * The prepaid expenses for the booking. * Format: numeric * Max length: 12 characters + * + * @param lodgingPrepaidExpenses + */ @JsonProperty(JSON_PROPERTY_LODGING_PREPAID_EXPENSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingPrepaidExpenses(String lodgingPrepaidExpenses) { @@ -345,6 +389,11 @@ public String getLodgingPropertyPhoneNumber() { } + /** + * The lodging property location's phone number. * Format: numeric. * Min length: 10 characters * Max length: 17 characters * For US and CA numbers must be 10 characters in length * Must not start with a space * Must not contain any special characters such as + or - *Must not be all zeros. + * + * @param lodgingPropertyPhoneNumber + */ @JsonProperty(JSON_PROPERTY_LODGING_PROPERTY_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingPropertyPhoneNumber(String lodgingPropertyPhoneNumber) { @@ -370,6 +419,11 @@ public String getLodgingRoom1NumberOfNights() { } + /** + * The total number of nights the room is booked for. * Format: numeric * Must be a number between 0 and 99 * Max length: 4 characters + * + * @param lodgingRoom1NumberOfNights + */ @JsonProperty(JSON_PROPERTY_LODGING_ROOM1_NUMBER_OF_NIGHTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingRoom1NumberOfNights(String lodgingRoom1NumberOfNights) { @@ -395,6 +449,11 @@ public String getLodgingRoom1Rate() { } + /** + * The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number + * + * @param lodgingRoom1Rate + */ @JsonProperty(JSON_PROPERTY_LODGING_ROOM1_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingRoom1Rate(String lodgingRoom1Rate) { @@ -420,6 +479,11 @@ public String getLodgingTotalRoomTax() { } + /** + * The total room tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number + * + * @param lodgingTotalRoomTax + */ @JsonProperty(JSON_PROPERTY_LODGING_TOTAL_ROOM_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingTotalRoomTax(String lodgingTotalRoomTax) { @@ -445,6 +509,11 @@ public String getLodgingTotalTax() { } + /** + * The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). * Format: numeric * Max length: 12 characters * Must not be a negative number + * + * @param lodgingTotalTax + */ @JsonProperty(JSON_PROPERTY_LODGING_TOTAL_TAX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLodgingTotalTax(String lodgingTotalTax) { @@ -470,6 +539,11 @@ public String getTravelEntertainmentAuthDataDuration() { } + /** + * The number of nights. This should be included in the auth message. * Format: numeric * Max length: 4 characters + * + * @param travelEntertainmentAuthDataDuration + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_DURATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataDuration(String travelEntertainmentAuthDataDuration) { @@ -495,6 +569,11 @@ public String getTravelEntertainmentAuthDataMarket() { } + /** + * Indicates what market-specific dataset will be submitted. Must be 'H' for Hotel. This should be included in the auth message. * Format: alphanumeric * Max length: 1 character + * + * @param travelEntertainmentAuthDataMarket + */ @JsonProperty(JSON_PROPERTY_TRAVEL_ENTERTAINMENT_AUTH_DATA_MARKET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTravelEntertainmentAuthDataMarket(String travelEntertainmentAuthDataMarket) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataModifications.java b/src/main/java/com/adyen/model/payment/AdditionalDataModifications.java index ff9706862..17c820a64 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataModifications.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataModifications.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -60,6 +59,11 @@ public String getInstallmentPaymentDataSelectedInstallmentOption() { } + /** + * This is the installment option selected by the shopper. It is required only if specified by the user. + * + * @param installmentPaymentDataSelectedInstallmentOption + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_SELECTED_INSTALLMENT_OPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataSelectedInstallmentOption(String installmentPaymentDataSelectedInstallmentOption) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataOpenInvoice.java b/src/main/java/com/adyen/model/payment/AdditionalDataOpenInvoice.java index 0e45ad769..5456aaf19 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataOpenInvoice.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataOpenInvoice.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -128,6 +127,11 @@ public String getOpeninvoicedataMerchantData() { } + /** + * Holds different merchant data points like product, purchase, customer, and so on. It takes data in a Base64 encoded string. The `merchantData` parameter needs to be added to the `openinvoicedata` signature at the end. Since the field is optional, if it's not included it does not impact computing the merchant signature. Applies only to Klarna. You can contact Klarna for the format and structure of the string. + * + * @param openinvoicedataMerchantData + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_MERCHANT_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataMerchantData(String openinvoicedataMerchantData) { @@ -153,6 +157,11 @@ public String getOpeninvoicedataNumberOfLines() { } + /** + * The number of invoice lines included in `openinvoicedata`. There needs to be at least one line, so `numberOfLines` needs to be at least 1. + * + * @param openinvoicedataNumberOfLines + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_NUMBER_OF_LINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataNumberOfLines(String openinvoicedataNumberOfLines) { @@ -178,6 +187,11 @@ public String getOpeninvoicedataRecipientFirstName() { } + /** + * First name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. + * + * @param openinvoicedataRecipientFirstName + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_RECIPIENT_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataRecipientFirstName(String openinvoicedataRecipientFirstName) { @@ -203,6 +217,11 @@ public String getOpeninvoicedataRecipientLastName() { } + /** + * Last name of the recipient. If the delivery address and the billing address are different, specify the `recipientFirstName` and `recipientLastName` to share the delivery address with Klarna. Otherwise, only the billing address is shared with Klarna. + * + * @param openinvoicedataRecipientLastName + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_RECIPIENT_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataRecipientLastName(String openinvoicedataRecipientLastName) { @@ -228,6 +247,11 @@ public String getOpeninvoicedataLineItemNrCurrencyCode() { } + /** + * The three-character ISO currency code. + * + * @param openinvoicedataLineItemNrCurrencyCode + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrCurrencyCode(String openinvoicedataLineItemNrCurrencyCode) { @@ -253,6 +277,11 @@ public String getOpeninvoicedataLineItemNrDescription() { } + /** + * A text description of the product the invoice line refers to. + * + * @param openinvoicedataLineItemNrDescription + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrDescription(String openinvoicedataLineItemNrDescription) { @@ -278,6 +307,11 @@ public String getOpeninvoicedataLineItemNrItemAmount() { } + /** + * The price for one item in the invoice line, represented in minor units. The due amount for the item, VAT excluded. + * + * @param openinvoicedataLineItemNrItemAmount + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemAmount(String openinvoicedataLineItemNrItemAmount) { @@ -303,6 +337,11 @@ public String getOpeninvoicedataLineItemNrItemId() { } + /** + * A unique id for this item. Required for RatePay if the description of each item is not unique. + * + * @param openinvoicedataLineItemNrItemId + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemId(String openinvoicedataLineItemNrItemId) { @@ -328,6 +367,11 @@ public String getOpeninvoicedataLineItemNrItemVatAmount() { } + /** + * The VAT due for one item in the invoice line, represented in minor units. + * + * @param openinvoicedataLineItemNrItemVatAmount + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_VAT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemVatAmount(String openinvoicedataLineItemNrItemVatAmount) { @@ -353,6 +397,11 @@ public String getOpeninvoicedataLineItemNrItemVatPercentage() { } + /** + * The VAT percentage for one item in the invoice line, represented in minor units. For example, 19% VAT is specified as 1900. + * + * @param openinvoicedataLineItemNrItemVatPercentage + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_ITEM_VAT_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrItemVatPercentage(String openinvoicedataLineItemNrItemVatPercentage) { @@ -378,6 +427,11 @@ public String getOpeninvoicedataLineItemNrNumberOfItems() { } + /** + * The number of units purchased of a specific product. + * + * @param openinvoicedataLineItemNrNumberOfItems + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_NUMBER_OF_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrNumberOfItems(String openinvoicedataLineItemNrNumberOfItems) { @@ -403,6 +457,11 @@ public String getOpeninvoicedataLineItemNrReturnShippingCompany() { } + /** + * Name of the shipping company handling the the return shipment. + * + * @param openinvoicedataLineItemNrReturnShippingCompany + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_RETURN_SHIPPING_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrReturnShippingCompany(String openinvoicedataLineItemNrReturnShippingCompany) { @@ -428,6 +487,11 @@ public String getOpeninvoicedataLineItemNrReturnTrackingNumber() { } + /** + * The tracking number for the return of the shipment. + * + * @param openinvoicedataLineItemNrReturnTrackingNumber + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_RETURN_TRACKING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrReturnTrackingNumber(String openinvoicedataLineItemNrReturnTrackingNumber) { @@ -453,6 +517,11 @@ public String getOpeninvoicedataLineItemNrReturnTrackingUri() { } + /** + * URI where the customer can track the return of their shipment. + * + * @param openinvoicedataLineItemNrReturnTrackingUri + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_RETURN_TRACKING_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrReturnTrackingUri(String openinvoicedataLineItemNrReturnTrackingUri) { @@ -478,6 +547,11 @@ public String getOpeninvoicedataLineItemNrShippingCompany() { } + /** + * Name of the shipping company handling the delivery. + * + * @param openinvoicedataLineItemNrShippingCompany + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_SHIPPING_COMPANY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrShippingCompany(String openinvoicedataLineItemNrShippingCompany) { @@ -503,6 +577,11 @@ public String getOpeninvoicedataLineItemNrShippingMethod() { } + /** + * Shipping method. + * + * @param openinvoicedataLineItemNrShippingMethod + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_SHIPPING_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrShippingMethod(String openinvoicedataLineItemNrShippingMethod) { @@ -528,6 +607,11 @@ public String getOpeninvoicedataLineItemNrTrackingNumber() { } + /** + * The tracking number for the shipment. + * + * @param openinvoicedataLineItemNrTrackingNumber + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_TRACKING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrTrackingNumber(String openinvoicedataLineItemNrTrackingNumber) { @@ -553,6 +637,11 @@ public String getOpeninvoicedataLineItemNrTrackingUri() { } + /** + * URI where the customer can track their shipment. + * + * @param openinvoicedataLineItemNrTrackingUri + */ @JsonProperty(JSON_PROPERTY_OPENINVOICEDATA_LINE_ITEM_NR_TRACKING_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpeninvoicedataLineItemNrTrackingUri(String openinvoicedataLineItemNrTrackingUri) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataOpi.java b/src/main/java/com/adyen/model/payment/AdditionalDataOpi.java index 766b74f71..d7b461309 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataOpi.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataOpi.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -60,6 +59,11 @@ public String getOpiIncludeTransToken() { } + /** + * Optional boolean indicator. Set to **true** if you want an ecommerce transaction to return an `opi.transToken` as additional data in the response. You can store this Oracle Payment Interface token in your Oracle Opera database. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + * + * @param opiIncludeTransToken + */ @JsonProperty(JSON_PROPERTY_OPI_INCLUDE_TRANS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpiIncludeTransToken(String opiIncludeTransToken) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataRatepay.java b/src/main/java/com/adyen/model/payment/AdditionalDataRatepay.java index 7b5d90132..3d77e6c18 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataRatepay.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataRatepay.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -88,6 +87,11 @@ public String getRatepayInstallmentAmount() { } + /** + * Amount the customer has to pay each month. + * + * @param ratepayInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_RATEPAY_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayInstallmentAmount(String ratepayInstallmentAmount) { @@ -113,6 +117,11 @@ public String getRatepayInterestRate() { } + /** + * Interest rate of this installment. + * + * @param ratepayInterestRate + */ @JsonProperty(JSON_PROPERTY_RATEPAY_INTEREST_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayInterestRate(String ratepayInterestRate) { @@ -138,6 +147,11 @@ public String getRatepayLastInstallmentAmount() { } + /** + * Amount of the last installment. + * + * @param ratepayLastInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_RATEPAY_LAST_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayLastInstallmentAmount(String ratepayLastInstallmentAmount) { @@ -163,6 +177,11 @@ public String getRatepayPaymentFirstday() { } + /** + * Calendar day of the first payment. + * + * @param ratepayPaymentFirstday + */ @JsonProperty(JSON_PROPERTY_RATEPAY_PAYMENT_FIRSTDAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepayPaymentFirstday(String ratepayPaymentFirstday) { @@ -188,6 +207,11 @@ public String getRatepaydataDeliveryDate() { } + /** + * Date the merchant delivered the goods to the customer. + * + * @param ratepaydataDeliveryDate + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataDeliveryDate(String ratepaydataDeliveryDate) { @@ -213,6 +237,11 @@ public String getRatepaydataDueDate() { } + /** + * Date by which the customer must settle the payment. + * + * @param ratepaydataDueDate + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_DUE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataDueDate(String ratepaydataDueDate) { @@ -238,6 +267,11 @@ public String getRatepaydataInvoiceDate() { } + /** + * Invoice date, defined by the merchant. If not included, the invoice date is set to the delivery date. + * + * @param ratepaydataInvoiceDate + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_INVOICE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataInvoiceDate(String ratepaydataInvoiceDate) { @@ -263,6 +297,11 @@ public String getRatepaydataInvoiceId() { } + /** + * Identification name or number for the invoice, defined by the merchant. + * + * @param ratepaydataInvoiceId + */ @JsonProperty(JSON_PROPERTY_RATEPAYDATA_INVOICE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRatepaydataInvoiceId(String ratepaydataInvoiceId) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataRetry.java b/src/main/java/com/adyen/model/payment/AdditionalDataRetry.java index 90a5c9599..d57bd4700 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataRetry.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataRetry.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public String getRetryChainAttemptNumber() { } + /** + * The number of times the transaction (not order) has been retried between different payment service providers. For instance, the `chainAttemptNumber` set to 2 means that this transaction has been recently tried on another provider before being sent to Adyen. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + * + * @param retryChainAttemptNumber + */ @JsonProperty(JSON_PROPERTY_RETRY_CHAIN_ATTEMPT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetryChainAttemptNumber(String retryChainAttemptNumber) { @@ -93,6 +97,11 @@ public String getRetryOrderAttemptNumber() { } + /** + * The index of the attempt to bill a particular order, which is identified by the `merchantOrderReference` field. For example, if a recurring transaction fails and is retried one day later, then the order number for these attempts would be 1 and 2, respectively. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + * + * @param retryOrderAttemptNumber + */ @JsonProperty(JSON_PROPERTY_RETRY_ORDER_ATTEMPT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetryOrderAttemptNumber(String retryOrderAttemptNumber) { @@ -118,6 +127,11 @@ public String getRetrySkipRetry() { } + /** + * The Boolean value indicating whether Adyen should skip or retry this transaction, if possible. > If you submit `retry.chainAttemptNumber`, `retry.orderAttemptNumber`, and `retry.skipRetry` values, we also recommend you provide the `merchantOrderReference` to facilitate linking payment attempts together. + * + * @param retrySkipRetry + */ @JsonProperty(JSON_PROPERTY_RETRY_SKIP_RETRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRetrySkipRetry(String retrySkipRetry) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataRisk.java b/src/main/java/com/adyen/model/payment/AdditionalDataRisk.java index 861a23f50..f716b897f 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataRisk.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataRisk.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -140,6 +139,11 @@ public String getRiskdataCustomFieldName() { } + /** + * The data for your custom risk field. For more information, refer to [Create custom risk fields](https://docs.adyen.com/risk-management/configure-custom-risk-rules#step-1-create-custom-risk-fields). + * + * @param riskdataCustomFieldName + */ @JsonProperty(JSON_PROPERTY_RISKDATA_CUSTOM_FIELD_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataCustomFieldName(String riskdataCustomFieldName) { @@ -165,6 +169,11 @@ public String getRiskdataBasketItemItemNrAmountPerItem() { } + /** + * The price of item in the basket, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param riskdataBasketItemItemNrAmountPerItem + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_AMOUNT_PER_ITEM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrAmountPerItem(String riskdataBasketItemItemNrAmountPerItem) { @@ -190,6 +199,11 @@ public String getRiskdataBasketItemItemNrBrand() { } + /** + * Brand of the item. + * + * @param riskdataBasketItemItemNrBrand + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrBrand(String riskdataBasketItemItemNrBrand) { @@ -215,6 +229,11 @@ public String getRiskdataBasketItemItemNrCategory() { } + /** + * Category of the item. + * + * @param riskdataBasketItemItemNrCategory + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrCategory(String riskdataBasketItemItemNrCategory) { @@ -240,6 +259,11 @@ public String getRiskdataBasketItemItemNrColor() { } + /** + * Color of the item. + * + * @param riskdataBasketItemItemNrColor + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrColor(String riskdataBasketItemItemNrColor) { @@ -265,6 +289,11 @@ public String getRiskdataBasketItemItemNrCurrency() { } + /** + * The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param riskdataBasketItemItemNrCurrency + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrCurrency(String riskdataBasketItemItemNrCurrency) { @@ -290,6 +319,11 @@ public String getRiskdataBasketItemItemNrItemID() { } + /** + * ID of the item. + * + * @param riskdataBasketItemItemNrItemID + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_ITEM_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrItemID(String riskdataBasketItemItemNrItemID) { @@ -315,6 +349,11 @@ public String getRiskdataBasketItemItemNrManufacturer() { } + /** + * Manufacturer of the item. + * + * @param riskdataBasketItemItemNrManufacturer + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_MANUFACTURER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrManufacturer(String riskdataBasketItemItemNrManufacturer) { @@ -340,6 +379,11 @@ public String getRiskdataBasketItemItemNrProductTitle() { } + /** + * A text description of the product the invoice line refers to. + * + * @param riskdataBasketItemItemNrProductTitle + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_PRODUCT_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrProductTitle(String riskdataBasketItemItemNrProductTitle) { @@ -365,6 +409,11 @@ public String getRiskdataBasketItemItemNrQuantity() { } + /** + * Quantity of the item purchased. + * + * @param riskdataBasketItemItemNrQuantity + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_QUANTITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrQuantity(String riskdataBasketItemItemNrQuantity) { @@ -390,6 +439,11 @@ public String getRiskdataBasketItemItemNrReceiverEmail() { } + /** + * Email associated with the given product in the basket (usually in electronic gift cards). + * + * @param riskdataBasketItemItemNrReceiverEmail + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_RECEIVER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrReceiverEmail(String riskdataBasketItemItemNrReceiverEmail) { @@ -415,6 +469,11 @@ public String getRiskdataBasketItemItemNrSize() { } + /** + * Size of the item. + * + * @param riskdataBasketItemItemNrSize + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrSize(String riskdataBasketItemItemNrSize) { @@ -440,6 +499,11 @@ public String getRiskdataBasketItemItemNrSku() { } + /** + * [Stock keeping unit](https://en.wikipedia.org/wiki/Stock_keeping_unit). + * + * @param riskdataBasketItemItemNrSku + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_SKU) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrSku(String riskdataBasketItemItemNrSku) { @@ -465,6 +529,11 @@ public String getRiskdataBasketItemItemNrUpc() { } + /** + * [Universal Product Code](https://en.wikipedia.org/wiki/Universal_Product_Code). + * + * @param riskdataBasketItemItemNrUpc + */ @JsonProperty(JSON_PROPERTY_RISKDATA_BASKET_ITEM_ITEM_NR_UPC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataBasketItemItemNrUpc(String riskdataBasketItemItemNrUpc) { @@ -490,6 +559,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionCode() { } + /** + * Code of the promotion. + * + * @param riskdataPromotionsPromotionItemNrPromotionCode + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionCode(String riskdataPromotionsPromotionItemNrPromotionCode) { @@ -515,6 +589,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionDiscountAmount() { } + /** + * The discount amount of the promotion, represented in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param riskdataPromotionsPromotionItemNrPromotionDiscountAmount + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionDiscountAmount(String riskdataPromotionsPromotionItemNrPromotionDiscountAmount) { @@ -540,6 +619,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency() { } + /** + * The three-character [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217). + * + * @param riskdataPromotionsPromotionItemNrPromotionDiscountCurrency + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionDiscountCurrency(String riskdataPromotionsPromotionItemNrPromotionDiscountCurrency) { @@ -565,6 +649,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage() } + /** + * Promotion's percentage discount. It is represented in percentage value and there is no need to include the '%' sign. e.g. for a promotion discount of 30%, the value of the field should be 30. + * + * @param riskdataPromotionsPromotionItemNrPromotionDiscountPercentage + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_DISCOUNT_PERCENTAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionDiscountPercentage(String riskdataPromotionsPromotionItemNrPromotionDiscountPercentage) { @@ -590,6 +679,11 @@ public String getRiskdataPromotionsPromotionItemNrPromotionName() { } + /** + * Name of the promotion. + * + * @param riskdataPromotionsPromotionItemNrPromotionName + */ @JsonProperty(JSON_PROPERTY_RISKDATA_PROMOTIONS_PROMOTION_ITEM_NR_PROMOTION_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataPromotionsPromotionItemNrPromotionName(String riskdataPromotionsPromotionItemNrPromotionName) { @@ -615,6 +709,11 @@ public String getRiskdataRiskProfileReference() { } + /** + * Reference number of the risk profile that you want to apply to the payment. If not provided or left blank, the merchant-level account's default risk profile will be applied to the payment. For more information, see [dynamically assign a risk profile to a payment](https://docs.adyen.com/risk-management/create-and-use-risk-profiles#dynamically-assign-a-risk-profile-to-a-payment). + * + * @param riskdataRiskProfileReference + */ @JsonProperty(JSON_PROPERTY_RISKDATA_RISK_PROFILE_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataRiskProfileReference(String riskdataRiskProfileReference) { @@ -640,6 +739,11 @@ public String getRiskdataSkipRisk() { } + /** + * If this parameter is provided with the value **true**, risk checks for the payment request are skipped and the transaction will not get a risk score. + * + * @param riskdataSkipRisk + */ @JsonProperty(JSON_PROPERTY_RISKDATA_SKIP_RISK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskdataSkipRisk(String riskdataSkipRisk) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataRiskStandalone.java b/src/main/java/com/adyen/model/payment/AdditionalDataRiskStandalone.java index c5c407f65..e4524df9d 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataRiskStandalone.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataRiskStandalone.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -116,6 +115,11 @@ public String getPayPalCountryCode() { } + /** + * Shopper's country of residence in the form of ISO standard 3166 2-character country codes. + * + * @param payPalCountryCode + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalCountryCode(String payPalCountryCode) { @@ -141,6 +145,11 @@ public String getPayPalEmailId() { } + /** + * Shopper's email. + * + * @param payPalEmailId + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_EMAIL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalEmailId(String payPalEmailId) { @@ -166,6 +175,11 @@ public String getPayPalFirstName() { } + /** + * Shopper's first name. + * + * @param payPalFirstName + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalFirstName(String payPalFirstName) { @@ -191,6 +205,11 @@ public String getPayPalLastName() { } + /** + * Shopper's last name. + * + * @param payPalLastName + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalLastName(String payPalLastName) { @@ -216,6 +235,11 @@ public String getPayPalPayerId() { } + /** + * Unique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters. + * + * @param payPalPayerId + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_PAYER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalPayerId(String payPalPayerId) { @@ -241,6 +265,11 @@ public String getPayPalPhone() { } + /** + * Shopper's phone number. + * + * @param payPalPhone + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalPhone(String payPalPhone) { @@ -266,6 +295,11 @@ public String getPayPalProtectionEligibility() { } + /** + * Allowed values: * **Eligible** — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received. * **PartiallyEligible** — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received. * **Ineligible** — Merchant is not protected under the Seller Protection Policy. + * + * @param payPalProtectionEligibility + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_PROTECTION_ELIGIBILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalProtectionEligibility(String payPalProtectionEligibility) { @@ -291,6 +325,11 @@ public String getPayPalTransactionId() { } + /** + * Unique transaction ID of the payment. + * + * @param payPalTransactionId + */ @JsonProperty(JSON_PROPERTY_PAY_PAL_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayPalTransactionId(String payPalTransactionId) { @@ -316,6 +355,11 @@ public String getAvsResultRaw() { } + /** + * Raw AVS result received from the acquirer, where available. Example: D + * + * @param avsResultRaw + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResultRaw(String avsResultRaw) { @@ -341,6 +385,11 @@ public String getBin() { } + /** + * The Bank Identification Number of a credit card, which is the first six digits of a card number. Required for [tokenized card request](https://docs.adyen.com/risk-management/standalone-risk#tokenised-pan-request). + * + * @param bin + */ @JsonProperty(JSON_PROPERTY_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBin(String bin) { @@ -366,6 +415,11 @@ public String getCvcResultRaw() { } + /** + * Raw CVC result received from the acquirer, where available. Example: 1 + * + * @param cvcResultRaw + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResultRaw(String cvcResultRaw) { @@ -391,6 +445,11 @@ public String getRiskToken() { } + /** + * Unique identifier or token for the shopper's card details. + * + * @param riskToken + */ @JsonProperty(JSON_PROPERTY_RISK_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskToken(String riskToken) { @@ -416,6 +475,11 @@ public String getThreeDAuthenticated() { } + /** + * A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true + * + * @param threeDAuthenticated + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticated(String threeDAuthenticated) { @@ -441,6 +505,11 @@ public String getThreeDOffered() { } + /** + * A Boolean value indicating whether 3DS was offered for this payment. Example: true + * + * @param threeDOffered + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOffered(String threeDOffered) { @@ -466,6 +535,11 @@ public String getTokenDataType() { } + /** + * Required for PayPal payments only. The only supported value is: **paypal**. + * + * @param tokenDataType + */ @JsonProperty(JSON_PROPERTY_TOKEN_DATA_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenDataType(String tokenDataType) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataSubMerchant.java b/src/main/java/com/adyen/model/payment/AdditionalDataSubMerchant.java index ddd65cfc5..65f3e747e 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataSubMerchant.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataSubMerchant.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -96,6 +95,11 @@ public String getSubMerchantNumberOfSubSellers() { } + /** + * Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**. + * + * @param subMerchantNumberOfSubSellers + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_NUMBER_OF_SUB_SELLERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantNumberOfSubSellers(String subMerchantNumberOfSubSellers) { @@ -121,6 +125,11 @@ public String getSubMerchantSubSellerSubSellerNrCity() { } + /** + * Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters + * + * @param subMerchantSubSellerSubSellerNrCity + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrCity(String subMerchantSubSellerSubSellerNrCity) { @@ -146,6 +155,11 @@ public String getSubMerchantSubSellerSubSellerNrCountry() { } + /** + * Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters + * + * @param subMerchantSubSellerSubSellerNrCountry + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrCountry(String subMerchantSubSellerSubSellerNrCountry) { @@ -171,6 +185,11 @@ public String getSubMerchantSubSellerSubSellerNrId() { } + /** + * Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. * Format: Alphanumeric * Maximum length: 15 characters + * + * @param subMerchantSubSellerSubSellerNrId + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrId(String subMerchantSubSellerSubSellerNrId) { @@ -196,6 +215,11 @@ public String getSubMerchantSubSellerSubSellerNrMcc() { } + /** + * Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits + * + * @param subMerchantSubSellerSubSellerNrMcc + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrMcc(String subMerchantSubSellerSubSellerNrMcc) { @@ -221,6 +245,11 @@ public String getSubMerchantSubSellerSubSellerNrName() { } + /** + * Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters + * + * @param subMerchantSubSellerSubSellerNrName + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrName(String subMerchantSubSellerSubSellerNrName) { @@ -246,6 +275,11 @@ public String getSubMerchantSubSellerSubSellerNrPostalCode() { } + /** + * Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes. * Format: Numeric * Fixed length: 8 digits + * + * @param subMerchantSubSellerSubSellerNrPostalCode + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrPostalCode(String subMerchantSubSellerSubSellerNrPostalCode) { @@ -271,6 +305,11 @@ public String getSubMerchantSubSellerSubSellerNrState() { } + /** + * Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country. * Format: Alphanumeric * Maximum length: 2 characters + * + * @param subMerchantSubSellerSubSellerNrState + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrState(String subMerchantSubSellerSubSellerNrState) { @@ -296,6 +335,11 @@ public String getSubMerchantSubSellerSubSellerNrStreet() { } + /** + * Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 60 characters + * + * @param subMerchantSubSellerSubSellerNrStreet + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrStreet(String subMerchantSubSellerSubSellerNrStreet) { @@ -321,6 +365,11 @@ public String getSubMerchantSubSellerSubSellerNrTaxId() { } + /** + * Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ + * + * @param subMerchantSubSellerSubSellerNrTaxId + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT_SUB_SELLER_SUB_SELLER_NR_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchantSubSellerSubSellerNrTaxId(String subMerchantSubSellerSubSellerNrTaxId) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataTemporaryServices.java b/src/main/java/com/adyen/model/payment/AdditionalDataTemporaryServices.java index 25a7e21ca..2141fc241 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataTemporaryServices.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataTemporaryServices.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -92,6 +91,11 @@ public String getEnhancedSchemeDataCustomerReference() { } + /** + * The customer code, if supplied by a customer. * Encoding: ASCII * maxLength: 25 + * + * @param enhancedSchemeDataCustomerReference + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_CUSTOMER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataCustomerReference(String enhancedSchemeDataCustomerReference) { @@ -117,6 +121,11 @@ public String getEnhancedSchemeDataEmployeeName() { } + /** + * The name or ID of the person working in a temporary capacity. * maxLength: 40. * Must not be all spaces. *Must not be all zeros. + * + * @param enhancedSchemeDataEmployeeName + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_EMPLOYEE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataEmployeeName(String enhancedSchemeDataEmployeeName) { @@ -142,6 +151,11 @@ public String getEnhancedSchemeDataJobDescription() { } + /** + * The job description of the person working in a temporary capacity. * maxLength: 40 * Must not be all spaces. *Must not be all zeros. + * + * @param enhancedSchemeDataJobDescription + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_JOB_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataJobDescription(String enhancedSchemeDataJobDescription) { @@ -167,6 +181,11 @@ public String getEnhancedSchemeDataRegularHoursRate() { } + /** + * The amount paid for regular hours worked, [minor units](https://docs.adyen.com/development-resources/currency-codes). * maxLength: 7 * Must not be empty * Can be all zeros + * + * @param enhancedSchemeDataRegularHoursRate + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_REGULAR_HOURS_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataRegularHoursRate(String enhancedSchemeDataRegularHoursRate) { @@ -192,6 +211,11 @@ public String getEnhancedSchemeDataRegularHoursWorked() { } + /** + * The hours worked. * maxLength: 7 * Must not be empty * Can be all zeros + * + * @param enhancedSchemeDataRegularHoursWorked + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_REGULAR_HOURS_WORKED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataRegularHoursWorked(String enhancedSchemeDataRegularHoursWorked) { @@ -217,6 +241,11 @@ public String getEnhancedSchemeDataRequestName() { } + /** + * The name of the person requesting temporary services. * maxLength: 40 * Must not be all zeros * Must not be all spaces + * + * @param enhancedSchemeDataRequestName + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_REQUEST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataRequestName(String enhancedSchemeDataRequestName) { @@ -242,6 +271,11 @@ public String getEnhancedSchemeDataTempStartDate() { } + /** + * The billing period start date. * Format: ddMMyy * maxLength: 6 + * + * @param enhancedSchemeDataTempStartDate + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TEMP_START_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTempStartDate(String enhancedSchemeDataTempStartDate) { @@ -267,6 +301,11 @@ public String getEnhancedSchemeDataTempWeekEnding() { } + /** + * The billing period end date. * Format: ddMMyy * maxLength: 6 + * + * @param enhancedSchemeDataTempWeekEnding + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TEMP_WEEK_ENDING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTempWeekEnding(String enhancedSchemeDataTempWeekEnding) { @@ -292,6 +331,11 @@ public String getEnhancedSchemeDataTotalTaxAmount() { } + /** + * The total tax amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). For example, 2000 means USD 20.00 * maxLength: 12 + * + * @param enhancedSchemeDataTotalTaxAmount + */ @JsonProperty(JSON_PROPERTY_ENHANCED_SCHEME_DATA_TOTAL_TAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnhancedSchemeDataTotalTaxAmount(String enhancedSchemeDataTotalTaxAmount) { diff --git a/src/main/java/com/adyen/model/payment/AdditionalDataWallets.java b/src/main/java/com/adyen/model/payment/AdditionalDataWallets.java index f57ed9f8f..096ea0fe3 100644 --- a/src/main/java/com/adyen/model/payment/AdditionalDataWallets.java +++ b/src/main/java/com/adyen/model/payment/AdditionalDataWallets.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -80,6 +79,11 @@ public String getAndroidpayToken() { } + /** + * The Android Pay token retrieved from the SDK. + * + * @param androidpayToken + */ @JsonProperty(JSON_PROPERTY_ANDROIDPAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAndroidpayToken(String androidpayToken) { @@ -105,6 +109,11 @@ public String getMasterpassTransactionId() { } + /** + * The Mastercard Masterpass Transaction ID retrieved from the SDK. + * + * @param masterpassTransactionId + */ @JsonProperty(JSON_PROPERTY_MASTERPASS_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMasterpassTransactionId(String masterpassTransactionId) { @@ -130,6 +139,11 @@ public String getPaymentToken() { } + /** + * The Apple Pay token retrieved from the SDK. + * + * @param paymentToken + */ @JsonProperty(JSON_PROPERTY_PAYMENT_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentToken(String paymentToken) { @@ -155,6 +169,11 @@ public String getPaywithgoogleToken() { } + /** + * The Google Pay token retrieved from the SDK. + * + * @param paywithgoogleToken + */ @JsonProperty(JSON_PROPERTY_PAYWITHGOOGLE_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaywithgoogleToken(String paywithgoogleToken) { @@ -180,6 +199,11 @@ public String getSamsungpayToken() { } + /** + * The Samsung Pay token retrieved from the SDK. + * + * @param samsungpayToken + */ @JsonProperty(JSON_PROPERTY_SAMSUNGPAY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSamsungpayToken(String samsungpayToken) { @@ -205,6 +229,11 @@ public String getVisacheckoutCallId() { } + /** + * The Visa Checkout Call ID retrieved from the SDK. + * + * @param visacheckoutCallId + */ @JsonProperty(JSON_PROPERTY_VISACHECKOUT_CALL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisacheckoutCallId(String visacheckoutCallId) { diff --git a/src/main/java/com/adyen/model/payment/Address.java b/src/main/java/com/adyen/model/payment/Address.java index 94f7c4aa7..f318e6ca0 100644 --- a/src/main/java/com/adyen/model/payment/Address.java +++ b/src/main/java/com/adyen/model/payment/Address.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -80,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -105,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -130,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -155,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -180,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -205,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/payment/AdjustAuthorisationRequest.java b/src/main/java/com/adyen/model/payment/AdjustAuthorisationRequest.java index 9734f14bd..854c6d86b 100644 --- a/src/main/java/com/adyen/model/payment/AdjustAuthorisationRequest.java +++ b/src/main/java/com/adyen/model/payment/AdjustAuthorisationRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -116,6 +115,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -141,6 +145,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -166,6 +175,11 @@ public Amount getModificationAmount() { } + /** + * modificationAmount + * + * @param modificationAmount + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationAmount(Amount modificationAmount) { @@ -191,6 +205,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -216,6 +235,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -241,6 +265,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -266,6 +295,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -291,6 +325,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -324,6 +363,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -349,6 +393,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -374,6 +423,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payment/Amount.java b/src/main/java/com/adyen/model/payment/Amount.java index 67358192c..5260e1608 100644 --- a/src/main/java/com/adyen/model/payment/Amount.java +++ b/src/main/java/com/adyen/model/payment/Amount.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -89,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/payment/ApplicationInfo.java b/src/main/java/com/adyen/model/payment/ApplicationInfo.java index ba459882e..19b120740 100644 --- a/src/main/java/com/adyen/model/payment/ApplicationInfo.java +++ b/src/main/java/com/adyen/model/payment/ApplicationInfo.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -84,6 +83,11 @@ public CommonField getAdyenLibrary() { } + /** + * adyenLibrary + * + * @param adyenLibrary + */ @JsonProperty(JSON_PROPERTY_ADYEN_LIBRARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenLibrary(CommonField adyenLibrary) { @@ -109,6 +113,11 @@ public CommonField getAdyenPaymentSource() { } + /** + * adyenPaymentSource + * + * @param adyenPaymentSource + */ @JsonProperty(JSON_PROPERTY_ADYEN_PAYMENT_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdyenPaymentSource(CommonField adyenPaymentSource) { @@ -134,6 +143,11 @@ public ExternalPlatform getExternalPlatform() { } + /** + * externalPlatform + * + * @param externalPlatform + */ @JsonProperty(JSON_PROPERTY_EXTERNAL_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExternalPlatform(ExternalPlatform externalPlatform) { @@ -159,6 +173,11 @@ public CommonField getMerchantApplication() { } + /** + * merchantApplication + * + * @param merchantApplication + */ @JsonProperty(JSON_PROPERTY_MERCHANT_APPLICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantApplication(CommonField merchantApplication) { @@ -184,6 +203,11 @@ public MerchantDevice getMerchantDevice() { } + /** + * merchantDevice + * + * @param merchantDevice + */ @JsonProperty(JSON_PROPERTY_MERCHANT_DEVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantDevice(MerchantDevice merchantDevice) { @@ -209,6 +233,11 @@ public ShopperInteractionDevice getShopperInteractionDevice() { } + /** + * shopperInteractionDevice + * + * @param shopperInteractionDevice + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION_DEVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteractionDevice(ShopperInteractionDevice shopperInteractionDevice) { diff --git a/src/main/java/com/adyen/model/payment/AuthenticationResultRequest.java b/src/main/java/com/adyen/model/payment/AuthenticationResultRequest.java index 66212112c..7e2385e29 100644 --- a/src/main/java/com/adyen/model/payment/AuthenticationResultRequest.java +++ b/src/main/java/com/adyen/model/payment/AuthenticationResultRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which the authentication was processed. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -89,6 +93,11 @@ public String getPspReference() { } + /** + * The pspReference identifier for the transaction. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { diff --git a/src/main/java/com/adyen/model/payment/AuthenticationResultResponse.java b/src/main/java/com/adyen/model/payment/AuthenticationResultResponse.java index 9e907bbb4..84ec13a52 100644 --- a/src/main/java/com/adyen/model/payment/AuthenticationResultResponse.java +++ b/src/main/java/com/adyen/model/payment/AuthenticationResultResponse.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -66,6 +65,11 @@ public ThreeDS1Result getThreeDS1Result() { } + /** + * threeDS1Result + * + * @param threeDS1Result + */ @JsonProperty(JSON_PROPERTY_THREE_D_S1_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS1Result(ThreeDS1Result threeDS1Result) { @@ -91,6 +95,11 @@ public ThreeDS2Result getThreeDS2Result() { } + /** + * threeDS2Result + * + * @param threeDS2Result + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Result(ThreeDS2Result threeDS2Result) { diff --git a/src/main/java/com/adyen/model/payment/BankAccount.java b/src/main/java/com/adyen/model/payment/BankAccount.java index 1f08764ac..e8e5b4ec7 100644 --- a/src/main/java/com/adyen/model/payment/BankAccount.java +++ b/src/main/java/com/adyen/model/payment/BankAccount.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -92,6 +91,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -117,6 +121,11 @@ public String getBankCity() { } + /** + * The bank city. + * + * @param bankCity + */ @JsonProperty(JSON_PROPERTY_BANK_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCity(String bankCity) { @@ -142,6 +151,11 @@ public String getBankLocationId() { } + /** + * The location id of the bank. The field value is `nil` in most cases. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -167,6 +181,11 @@ public String getBankName() { } + /** + * The name of the bank. + * + * @param bankName + */ @JsonProperty(JSON_PROPERTY_BANK_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankName(String bankName) { @@ -192,6 +211,11 @@ public String getBic() { } + /** + * The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -217,6 +241,11 @@ public String getCountryCode() { } + /** + * Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL'). + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -242,6 +271,11 @@ public String getIban() { } + /** + * The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -267,6 +301,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -292,6 +331,11 @@ public String getTaxId() { } + /** + * The bank account holder's tax ID. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/payment/BrowserInfo.java b/src/main/java/com/adyen/model/payment/BrowserInfo.java index 6f69a60dc..25bcf5502 100644 --- a/src/main/java/com/adyen/model/payment/BrowserInfo.java +++ b/src/main/java/com/adyen/model/payment/BrowserInfo.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -92,6 +91,11 @@ public String getAcceptHeader() { } + /** + * The accept header value of the shopper's browser. + * + * @param acceptHeader + */ @JsonProperty(JSON_PROPERTY_ACCEPT_HEADER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcceptHeader(String acceptHeader) { @@ -117,6 +121,11 @@ public Integer getColorDepth() { } + /** + * The color depth of the shopper's browser in bits per pixel. This should be obtained by using the browser's `screen.colorDepth` property. Accepted values: 1, 4, 8, 15, 16, 24, 30, 32 or 48 bit color depth. + * + * @param colorDepth + */ @JsonProperty(JSON_PROPERTY_COLOR_DEPTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setColorDepth(Integer colorDepth) { @@ -142,6 +151,11 @@ public Boolean getJavaEnabled() { } + /** + * Boolean value indicating if the shopper's browser is able to execute Java. + * + * @param javaEnabled + */ @JsonProperty(JSON_PROPERTY_JAVA_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJavaEnabled(Boolean javaEnabled) { @@ -167,6 +181,11 @@ public Boolean getJavaScriptEnabled() { } + /** + * Boolean value indicating if the shopper's browser is able to execute JavaScript. A default 'true' value is assumed if the field is not present. + * + * @param javaScriptEnabled + */ @JsonProperty(JSON_PROPERTY_JAVA_SCRIPT_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setJavaScriptEnabled(Boolean javaScriptEnabled) { @@ -192,6 +211,11 @@ public String getLanguage() { } + /** + * The `navigator.language` value of the shopper's browser (as defined in IETF BCP 47). + * + * @param language + */ @JsonProperty(JSON_PROPERTY_LANGUAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLanguage(String language) { @@ -217,6 +241,11 @@ public Integer getScreenHeight() { } + /** + * The total height of the shopper's device screen in pixels. + * + * @param screenHeight + */ @JsonProperty(JSON_PROPERTY_SCREEN_HEIGHT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScreenHeight(Integer screenHeight) { @@ -242,6 +271,11 @@ public Integer getScreenWidth() { } + /** + * The total width of the shopper's device screen in pixels. + * + * @param screenWidth + */ @JsonProperty(JSON_PROPERTY_SCREEN_WIDTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScreenWidth(Integer screenWidth) { @@ -267,6 +301,11 @@ public Integer getTimeZoneOffset() { } + /** + * Time difference between UTC time and the shopper's browser local time, in minutes. + * + * @param timeZoneOffset + */ @JsonProperty(JSON_PROPERTY_TIME_ZONE_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimeZoneOffset(Integer timeZoneOffset) { @@ -292,6 +331,11 @@ public String getUserAgent() { } + /** + * The user agent value of the shopper's browser. + * + * @param userAgent + */ @JsonProperty(JSON_PROPERTY_USER_AGENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUserAgent(String userAgent) { diff --git a/src/main/java/com/adyen/model/payment/CancelOrRefundRequest.java b/src/main/java/com/adyen/model/payment/CancelOrRefundRequest.java index 40e74d442..052457cdb 100644 --- a/src/main/java/com/adyen/model/payment/CancelOrRefundRequest.java +++ b/src/main/java/com/adyen/model/payment/CancelOrRefundRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -105,6 +104,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -130,6 +134,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -155,6 +164,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -180,6 +194,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -205,6 +224,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -230,6 +254,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -255,6 +284,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -280,6 +314,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -305,6 +344,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payment/CancelRequest.java b/src/main/java/com/adyen/model/payment/CancelRequest.java index cc2d0af6a..eefd98802 100644 --- a/src/main/java/com/adyen/model/payment/CancelRequest.java +++ b/src/main/java/com/adyen/model/payment/CancelRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -111,6 +110,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -136,6 +140,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -161,6 +170,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -186,6 +200,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -211,6 +230,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -236,6 +260,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -261,6 +290,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -294,6 +328,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -319,6 +358,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -344,6 +388,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payment/CaptureRequest.java b/src/main/java/com/adyen/model/payment/CaptureRequest.java index 979f3fa7a..28a5170ce 100644 --- a/src/main/java/com/adyen/model/payment/CaptureRequest.java +++ b/src/main/java/com/adyen/model/payment/CaptureRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -116,6 +115,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -141,6 +145,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -166,6 +175,11 @@ public Amount getModificationAmount() { } + /** + * modificationAmount + * + * @param modificationAmount + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationAmount(Amount modificationAmount) { @@ -191,6 +205,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -216,6 +235,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -241,6 +265,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -266,6 +295,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -291,6 +325,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -324,6 +363,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -349,6 +393,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -374,6 +423,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payment/Card.java b/src/main/java/com/adyen/model/payment/Card.java index 7ff8a8a01..4976795e7 100644 --- a/src/main/java/com/adyen/model/payment/Card.java +++ b/src/main/java/com/adyen/model/payment/Card.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -88,6 +87,11 @@ public String getCvc() { } + /** + * The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 – length: 3 digits * CID – length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -113,6 +117,11 @@ public String getExpiryMonth() { } + /** + * The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -138,6 +147,11 @@ public String getExpiryYear() { } + /** + * The card expiry year. Format: 4 digits. For example: 2020 + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -163,6 +177,11 @@ public String getHolderName() { } + /** + * The name of the cardholder, as printed on the card. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -188,6 +207,11 @@ public String getIssueNumber() { } + /** + * The issue number of the card (for some UK debit cards only). + * + * @param issueNumber + */ @JsonProperty(JSON_PROPERTY_ISSUE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssueNumber(String issueNumber) { @@ -213,6 +237,11 @@ public String getNumber() { } + /** + * The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -238,6 +267,11 @@ public String getStartMonth() { } + /** + * The month component of the start date (for some UK debit cards only). + * + * @param startMonth + */ @JsonProperty(JSON_PROPERTY_START_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartMonth(String startMonth) { @@ -263,6 +297,11 @@ public String getStartYear() { } + /** + * The year component of the start date (for some UK debit cards only). + * + * @param startYear + */ @JsonProperty(JSON_PROPERTY_START_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartYear(String startYear) { diff --git a/src/main/java/com/adyen/model/payment/CommonField.java b/src/main/java/com/adyen/model/payment/CommonField.java index 0d8859dfd..de1e0cac6 100644 --- a/src/main/java/com/adyen/model/payment/CommonField.java +++ b/src/main/java/com/adyen/model/payment/CommonField.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getName() { } + /** + * Name of the field. For example, Name of External Platform. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -89,6 +93,11 @@ public String getVersion() { } + /** + * Version of the field. For example, Version of External Platform. + * + * @param version + */ @JsonProperty(JSON_PROPERTY_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersion(String version) { diff --git a/src/main/java/com/adyen/model/payment/DeviceRenderOptions.java b/src/main/java/com/adyen/model/payment/DeviceRenderOptions.java index a4809c8f5..2c1b804c1 100644 --- a/src/main/java/com/adyen/model/payment/DeviceRenderOptions.java +++ b/src/main/java/com/adyen/model/payment/DeviceRenderOptions.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -144,6 +143,11 @@ public SdkInterfaceEnum getSdkInterface() { } + /** + * Supported SDK interface types. Allowed values: * native * html * both + * + * @param sdkInterface + */ @JsonProperty(JSON_PROPERTY_SDK_INTERFACE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkInterface(SdkInterfaceEnum sdkInterface) { @@ -177,6 +181,11 @@ public List getSdkUiType() { } + /** + * UI types supported for displaying specific challenges. Allowed values: * text * singleSelect * outOfBand * otherHtml * multiSelect + * + * @param sdkUiType + */ @JsonProperty(JSON_PROPERTY_SDK_UI_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkUiType(List sdkUiType) { diff --git a/src/main/java/com/adyen/model/payment/DonationRequest.java b/src/main/java/com/adyen/model/payment/DonationRequest.java index c74103a49..8ea3233cf 100644 --- a/src/main/java/com/adyen/model/payment/DonationRequest.java +++ b/src/main/java/com/adyen/model/payment/DonationRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -82,6 +81,11 @@ public String getDonationAccount() { } + /** + * The Adyen account name of the charity. + * + * @param donationAccount + */ @JsonProperty(JSON_PROPERTY_DONATION_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDonationAccount(String donationAccount) { @@ -107,6 +111,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -132,6 +141,11 @@ public Amount getModificationAmount() { } + /** + * modificationAmount + * + * @param modificationAmount + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationAmount(Amount modificationAmount) { @@ -157,6 +171,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -182,6 +201,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -207,6 +231,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/payment/ExternalPlatform.java b/src/main/java/com/adyen/model/payment/ExternalPlatform.java index 05ac6f2ea..e10e41f08 100644 --- a/src/main/java/com/adyen/model/payment/ExternalPlatform.java +++ b/src/main/java/com/adyen/model/payment/ExternalPlatform.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public String getIntegrator() { } + /** + * External platform integrator. + * + * @param integrator + */ @JsonProperty(JSON_PROPERTY_INTEGRATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIntegrator(String integrator) { @@ -93,6 +97,11 @@ public String getName() { } + /** + * Name of the field. For example, Name of External Platform. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -118,6 +127,11 @@ public String getVersion() { } + /** + * Version of the field. For example, Version of External Platform. + * + * @param version + */ @JsonProperty(JSON_PROPERTY_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVersion(String version) { diff --git a/src/main/java/com/adyen/model/payment/ForexQuote.java b/src/main/java/com/adyen/model/payment/ForexQuote.java index f6b2026f3..ae031f276 100644 --- a/src/main/java/com/adyen/model/payment/ForexQuote.java +++ b/src/main/java/com/adyen/model/payment/ForexQuote.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -106,6 +105,11 @@ public String getAccount() { } + /** + * The account name. + * + * @param account + */ @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(String account) { @@ -131,6 +135,11 @@ public String getAccountType() { } + /** + * The account type. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(String accountType) { @@ -156,6 +165,11 @@ public Amount getBaseAmount() { } + /** + * baseAmount + * + * @param baseAmount + */ @JsonProperty(JSON_PROPERTY_BASE_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBaseAmount(Amount baseAmount) { @@ -181,6 +195,11 @@ public Integer getBasePoints() { } + /** + * The base points. + * + * @param basePoints + */ @JsonProperty(JSON_PROPERTY_BASE_POINTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBasePoints(Integer basePoints) { @@ -206,6 +225,11 @@ public Amount getBuy() { } + /** + * buy + * + * @param buy + */ @JsonProperty(JSON_PROPERTY_BUY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBuy(Amount buy) { @@ -231,6 +255,11 @@ public Amount getInterbank() { } + /** + * interbank + * + * @param interbank + */ @JsonProperty(JSON_PROPERTY_INTERBANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInterbank(Amount interbank) { @@ -256,6 +285,11 @@ public String getReference() { } + /** + * The reference assigned to the forex quote request. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -281,6 +315,11 @@ public Amount getSell() { } + /** + * sell + * + * @param sell + */ @JsonProperty(JSON_PROPERTY_SELL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSell(Amount sell) { @@ -306,6 +345,11 @@ public String getSignature() { } + /** + * The signature to validate the integrity. + * + * @param signature + */ @JsonProperty(JSON_PROPERTY_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSignature(String signature) { @@ -331,6 +375,11 @@ public String getSource() { } + /** + * The source of the forex quote. + * + * @param source + */ @JsonProperty(JSON_PROPERTY_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSource(String source) { @@ -356,6 +405,11 @@ public String getType() { } + /** + * The type of forex. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { @@ -381,6 +435,11 @@ public OffsetDateTime getValidTill() { } + /** + * The date until which the forex quote is valid. + * + * @param validTill + */ @JsonProperty(JSON_PROPERTY_VALID_TILL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidTill(OffsetDateTime validTill) { diff --git a/src/main/java/com/adyen/model/payment/FraudCheckResult.java b/src/main/java/com/adyen/model/payment/FraudCheckResult.java index 7b6dce822..117f5776e 100644 --- a/src/main/java/com/adyen/model/payment/FraudCheckResult.java +++ b/src/main/java/com/adyen/model/payment/FraudCheckResult.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public Integer getAccountScore() { } + /** + * The fraud score generated by the risk check. + * + * @param accountScore + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountScore(Integer accountScore) { @@ -93,6 +97,11 @@ public Integer getCheckId() { } + /** + * The ID of the risk check. + * + * @param checkId + */ @JsonProperty(JSON_PROPERTY_CHECK_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckId(Integer checkId) { @@ -118,6 +127,11 @@ public String getName() { } + /** + * The name of the risk check. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/payment/FraudCheckResultWrapper.java b/src/main/java/com/adyen/model/payment/FraudCheckResultWrapper.java index 80e57a9bb..ea0aa7992 100644 --- a/src/main/java/com/adyen/model/payment/FraudCheckResultWrapper.java +++ b/src/main/java/com/adyen/model/payment/FraudCheckResultWrapper.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -61,6 +60,11 @@ public FraudCheckResult getFraudCheckResult() { } + /** + * fraudCheckResult + * + * @param fraudCheckResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_CHECK_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudCheckResult(FraudCheckResult fraudCheckResult) { diff --git a/src/main/java/com/adyen/model/payment/FraudResult.java b/src/main/java/com/adyen/model/payment/FraudResult.java index 0176cb05f..218e7a71b 100644 --- a/src/main/java/com/adyen/model/payment/FraudResult.java +++ b/src/main/java/com/adyen/model/payment/FraudResult.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -67,6 +66,11 @@ public Integer getAccountScore() { } + /** + * The total fraud score generated by the risk checks. + * + * @param accountScore + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountScore(Integer accountScore) { @@ -100,6 +104,11 @@ public List getResults() { } + /** + * The result of the individual risk checks. + * + * @param results + */ @JsonProperty(JSON_PROPERTY_RESULTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResults(List results) { diff --git a/src/main/java/com/adyen/model/payment/FundDestination.java b/src/main/java/com/adyen/model/payment/FundDestination.java index fc77f7478..cea3e0755 100644 --- a/src/main/java/com/adyen/model/payment/FundDestination.java +++ b/src/main/java/com/adyen/model/payment/FundDestination.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -107,6 +106,11 @@ public Map getAdditionalData() { } + /** + * a map of name/value pairs for passing in additional/industry-specific data + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -132,6 +136,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -157,6 +166,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -182,6 +196,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -207,6 +226,11 @@ public String getShopperEmail() { } + /** + * the email address of the person + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -232,6 +256,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -257,6 +286,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -282,6 +316,11 @@ public SubMerchant getSubMerchant() { } + /** + * subMerchant + * + * @param subMerchant + */ @JsonProperty(JSON_PROPERTY_SUB_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubMerchant(SubMerchant subMerchant) { @@ -307,6 +346,11 @@ public String getTelephoneNumber() { } + /** + * the telephone number of the person + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { diff --git a/src/main/java/com/adyen/model/payment/FundSource.java b/src/main/java/com/adyen/model/payment/FundSource.java index a95a29dfb..de810b809 100644 --- a/src/main/java/com/adyen/model/payment/FundSource.java +++ b/src/main/java/com/adyen/model/payment/FundSource.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -94,6 +93,11 @@ public Map getAdditionalData() { } + /** + * A map of name-value pairs for passing additional or industry-specific data. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -119,6 +123,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -144,6 +153,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -169,6 +183,11 @@ public String getShopperEmail() { } + /** + * Email address of the person. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -194,6 +213,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -219,6 +243,11 @@ public String getTelephoneNumber() { } + /** + * Phone number of the person + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { diff --git a/src/main/java/com/adyen/model/payment/Installments.java b/src/main/java/com/adyen/model/payment/Installments.java index 1cb4bad34..c2c41d2dc 100644 --- a/src/main/java/com/adyen/model/payment/Installments.java +++ b/src/main/java/com/adyen/model/payment/Installments.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -99,6 +98,11 @@ public PlanEnum getPlan() { } + /** + * The installment plan, used for [card installments in Japan](https://docs.adyen.com/payment-methods/cards/credit-card-installments#make-a-payment-japan). By default, this is set to **regular**. Possible values: * **regular** * **revolving** + * + * @param plan + */ @JsonProperty(JSON_PROPERTY_PLAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlan(PlanEnum plan) { @@ -124,6 +128,11 @@ public Integer getValue() { } + /** + * Defines the number of installments. Its value needs to be greater than zero. Usually, the maximum allowed number of installments is capped. For example, it may not be possible to split a payment in more than 24 installments. The acquirer sets this upper limit, so its value may vary. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Integer value) { diff --git a/src/main/java/com/adyen/model/payment/Mandate.java b/src/main/java/com/adyen/model/payment/Mandate.java index 7403b28b7..e87ad38aa 100644 --- a/src/main/java/com/adyen/model/payment/Mandate.java +++ b/src/main/java/com/adyen/model/payment/Mandate.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -207,6 +206,11 @@ public String getAmount() { } + /** + * The billing amount (in minor units) of the recurring transactions. + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(String amount) { @@ -232,6 +236,11 @@ public AmountRuleEnum getAmountRule() { } + /** + * The limitation rule of the billing amount. Possible values: * **max**: The transaction amount can not exceed the `amount`. * **exact**: The transaction amount should be the same as the `amount`. + * + * @param amountRule + */ @JsonProperty(JSON_PROPERTY_AMOUNT_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountRule(AmountRuleEnum amountRule) { @@ -257,6 +266,11 @@ public BillingAttemptsRuleEnum getBillingAttemptsRule() { } + /** + * The rule to specify the period, within which the recurring debit can happen, relative to the mandate recurring date. Possible values: * **on**: On a specific date. * **before**: Before and on a specific date. * **after**: On and after a specific date. + * + * @param billingAttemptsRule + */ @JsonProperty(JSON_PROPERTY_BILLING_ATTEMPTS_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAttemptsRule(BillingAttemptsRuleEnum billingAttemptsRule) { @@ -282,6 +296,11 @@ public String getBillingDay() { } + /** + * The number of the day, on which the recurring debit can happen. Should be within the same calendar month as the mandate recurring date. Possible values: 1-31 based on the `frequency`. + * + * @param billingDay + */ @JsonProperty(JSON_PROPERTY_BILLING_DAY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingDay(String billingDay) { @@ -307,6 +326,11 @@ public String getEndsAt() { } + /** + * End date of the billing plan, in YYYY-MM-DD format. + * + * @param endsAt + */ @JsonProperty(JSON_PROPERTY_ENDS_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEndsAt(String endsAt) { @@ -332,6 +356,11 @@ public FrequencyEnum getFrequency() { } + /** + * The frequency with which a shopper should be charged. Possible values: **daily**, **weekly**, **biWeekly**, **monthly**, **quarterly**, **halfYearly**, **yearly**. + * + * @param frequency + */ @JsonProperty(JSON_PROPERTY_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFrequency(FrequencyEnum frequency) { @@ -357,6 +386,11 @@ public String getRemarks() { } + /** + * The message shown by UPI to the shopper on the approval screen. + * + * @param remarks + */ @JsonProperty(JSON_PROPERTY_REMARKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRemarks(String remarks) { @@ -382,6 +416,11 @@ public String getStartsAt() { } + /** + * Start date of the billing plan, in YYYY-MM-DD format. By default, the transaction date. + * + * @param startsAt + */ @JsonProperty(JSON_PROPERTY_STARTS_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartsAt(String startsAt) { diff --git a/src/main/java/com/adyen/model/payment/MerchantDevice.java b/src/main/java/com/adyen/model/payment/MerchantDevice.java index 7ab7943fc..84d046e13 100644 --- a/src/main/java/com/adyen/model/payment/MerchantDevice.java +++ b/src/main/java/com/adyen/model/payment/MerchantDevice.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public String getOs() { } + /** + * Operating system running on the merchant device. + * + * @param os + */ @JsonProperty(JSON_PROPERTY_OS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOs(String os) { @@ -93,6 +97,11 @@ public String getOsVersion() { } + /** + * Version of the operating system on the merchant device. + * + * @param osVersion + */ @JsonProperty(JSON_PROPERTY_OS_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOsVersion(String osVersion) { @@ -118,6 +127,11 @@ public String getReference() { } + /** + * Merchant device reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/payment/MerchantRiskIndicator.java b/src/main/java/com/adyen/model/payment/MerchantRiskIndicator.java index 6a887eef0..6a29a53ea 100644 --- a/src/main/java/com/adyen/model/payment/MerchantRiskIndicator.java +++ b/src/main/java/com/adyen/model/payment/MerchantRiskIndicator.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -198,6 +197,11 @@ public Boolean getAddressMatch() { } + /** + * Whether the chosen delivery address is identical to the billing address. + * + * @param addressMatch + */ @JsonProperty(JSON_PROPERTY_ADDRESS_MATCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddressMatch(Boolean addressMatch) { @@ -223,6 +227,11 @@ public DeliveryAddressIndicatorEnum getDeliveryAddressIndicator() { } + /** + * Indicator regarding the delivery address. Allowed values: * `shipToBillingAddress` * `shipToVerifiedAddress` * `shipToNewAddress` * `shipToStore` * `digitalGoods` * `goodsNotShipped` * `other` + * + * @param deliveryAddressIndicator + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddressIndicator(DeliveryAddressIndicatorEnum deliveryAddressIndicator) { @@ -250,6 +259,11 @@ public String getDeliveryEmail() { } + /** + * The delivery email address (for digital goods). + * + * @param deliveryEmail + */ @Deprecated @JsonProperty(JSON_PROPERTY_DELIVERY_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -276,6 +290,11 @@ public String getDeliveryEmailAddress() { } + /** + * For Electronic delivery, the email address to which the merchandise was delivered. Maximum length: 254 characters. + * + * @param deliveryEmailAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryEmailAddress(String deliveryEmailAddress) { @@ -301,6 +320,11 @@ public DeliveryTimeframeEnum getDeliveryTimeframe() { } + /** + * The estimated delivery time for the shopper to receive the goods. Allowed values: * `electronicDelivery` * `sameDayShipping` * `overnightShipping` * `twoOrMoreDaysShipping` + * + * @param deliveryTimeframe + */ @JsonProperty(JSON_PROPERTY_DELIVERY_TIMEFRAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryTimeframe(DeliveryTimeframeEnum deliveryTimeframe) { @@ -326,6 +350,11 @@ public Amount getGiftCardAmount() { } + /** + * giftCardAmount + * + * @param giftCardAmount + */ @JsonProperty(JSON_PROPERTY_GIFT_CARD_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiftCardAmount(Amount giftCardAmount) { @@ -351,6 +380,11 @@ public Integer getGiftCardCount() { } + /** + * For prepaid or gift card purchase, total count of individual prepaid or gift cards/codes purchased. + * + * @param giftCardCount + */ @JsonProperty(JSON_PROPERTY_GIFT_CARD_COUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiftCardCount(Integer giftCardCount) { @@ -376,6 +410,11 @@ public String getGiftCardCurr() { } + /** + * For prepaid or gift card purchase, [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) three-digit currency code of the gift card, other than those listed in Table A.5 of the EMVCo 3D Secure Protocol and Core Functions Specification. + * + * @param giftCardCurr + */ @JsonProperty(JSON_PROPERTY_GIFT_CARD_CURR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGiftCardCurr(String giftCardCurr) { @@ -401,6 +440,11 @@ public OffsetDateTime getPreOrderDate() { } + /** + * For pre-order purchases, the expected date this product will be available to the shopper. + * + * @param preOrderDate + */ @JsonProperty(JSON_PROPERTY_PRE_ORDER_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreOrderDate(OffsetDateTime preOrderDate) { @@ -426,6 +470,11 @@ public Boolean getPreOrderPurchase() { } + /** + * Indicator for whether this transaction is for pre-ordering a product. + * + * @param preOrderPurchase + */ @JsonProperty(JSON_PROPERTY_PRE_ORDER_PURCHASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreOrderPurchase(Boolean preOrderPurchase) { @@ -451,6 +500,11 @@ public String getPreOrderPurchaseInd() { } + /** + * Indicates whether Cardholder is placing an order for merchandise with a future availability or release date. + * + * @param preOrderPurchaseInd + */ @JsonProperty(JSON_PROPERTY_PRE_ORDER_PURCHASE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPreOrderPurchaseInd(String preOrderPurchaseInd) { @@ -476,6 +530,11 @@ public Boolean getReorderItems() { } + /** + * Indicator for whether the shopper has already purchased the same items in the past. + * + * @param reorderItems + */ @JsonProperty(JSON_PROPERTY_REORDER_ITEMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReorderItems(Boolean reorderItems) { @@ -501,6 +560,11 @@ public String getReorderItemsInd() { } + /** + * Indicates whether the cardholder is reordering previously purchased merchandise. + * + * @param reorderItemsInd + */ @JsonProperty(JSON_PROPERTY_REORDER_ITEMS_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReorderItemsInd(String reorderItemsInd) { @@ -526,6 +590,11 @@ public String getShipIndicator() { } + /** + * Indicates shipping method chosen for the transaction. + * + * @param shipIndicator + */ @JsonProperty(JSON_PROPERTY_SHIP_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShipIndicator(String shipIndicator) { diff --git a/src/main/java/com/adyen/model/payment/ModificationResult.java b/src/main/java/com/adyen/model/payment/ModificationResult.java index 0d4c6ba04..e660875ac 100644 --- a/src/main/java/com/adyen/model/payment/ModificationResult.java +++ b/src/main/java/com/adyen/model/payment/ModificationResult.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -126,6 +125,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be returned in a particular modification response. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -151,6 +155,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -176,6 +185,11 @@ public ResponseEnum getResponse() { } + /** + * Indicates if the modification request has been received for processing. + * + * @param response + */ @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponse(ResponseEnum response) { diff --git a/src/main/java/com/adyen/model/payment/Name.java b/src/main/java/com/adyen/model/payment/Name.java index 88ddc7b58..50396856f 100644 --- a/src/main/java/com/adyen/model/payment/Name.java +++ b/src/main/java/com/adyen/model/payment/Name.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -89,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/payment/PaymentRequest.java b/src/main/java/com/adyen/model/payment/PaymentRequest.java index 54b78681a..5404fd90c 100644 --- a/src/main/java/com/adyen/model/payment/PaymentRequest.java +++ b/src/main/java/com/adyen/model/payment/PaymentRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -439,6 +438,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -464,6 +468,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -497,6 +506,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -522,6 +536,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -547,6 +566,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -572,6 +596,11 @@ public BankAccount getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccount bankAccount) { @@ -597,6 +626,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -622,6 +656,11 @@ public BrowserInfo getBrowserInfo() { } + /** + * browserInfo + * + * @param browserInfo + */ @JsonProperty(JSON_PROPERTY_BROWSER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrowserInfo(BrowserInfo browserInfo) { @@ -647,6 +686,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -672,6 +716,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -697,6 +746,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -722,6 +776,11 @@ public ForexQuote getDccQuote() { } + /** + * dccQuote + * + * @param dccQuote + */ @JsonProperty(JSON_PROPERTY_DCC_QUOTE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccQuote(ForexQuote dccQuote) { @@ -747,6 +806,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -772,6 +836,11 @@ public OffsetDateTime getDeliveryDate() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliveryDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryDate(OffsetDateTime deliveryDate) { @@ -797,6 +866,11 @@ public String getDeviceFingerprint() { } + /** + * A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + * + * @param deviceFingerprint + */ @JsonProperty(JSON_PROPERTY_DEVICE_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceFingerprint(String deviceFingerprint) { @@ -822,6 +896,11 @@ public EntityTypeEnum getEntityType() { } + /** + * The type of the entity the payment is processed for. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(EntityTypeEnum entityType) { @@ -847,6 +926,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -872,6 +956,11 @@ public FundDestination getFundDestination() { } + /** + * fundDestination + * + * @param fundDestination + */ @JsonProperty(JSON_PROPERTY_FUND_DESTINATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundDestination(FundDestination fundDestination) { @@ -897,6 +986,11 @@ public FundSource getFundSource() { } + /** + * fundSource + * + * @param fundSource + */ @JsonProperty(JSON_PROPERTY_FUND_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundSource(FundSource fundSource) { @@ -922,6 +1016,11 @@ public FundingSourceEnum getFundingSource() { } + /** + * The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(FundingSourceEnum fundingSource) { @@ -947,6 +1046,11 @@ public Installments getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Installments installments) { @@ -980,6 +1084,11 @@ public Map getLocalizedShopperStatement() { } + /** + * The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. + * + * @param localizedShopperStatement + */ @JsonProperty(JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalizedShopperStatement(Map localizedShopperStatement) { @@ -1005,6 +1114,11 @@ public Mandate getMandate() { } + /** + * mandate + * + * @param mandate + */ @JsonProperty(JSON_PROPERTY_MANDATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMandate(Mandate mandate) { @@ -1030,6 +1144,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -1055,6 +1174,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -1080,6 +1204,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -1105,6 +1234,11 @@ public MerchantRiskIndicator getMerchantRiskIndicator() { } + /** + * merchantRiskIndicator + * + * @param merchantRiskIndicator + */ @JsonProperty(JSON_PROPERTY_MERCHANT_RISK_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) { @@ -1138,6 +1272,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -1163,6 +1302,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -1188,6 +1332,11 @@ public String getNationality() { } + /** + * The two-character country code of the shopper's nationality. + * + * @param nationality + */ @JsonProperty(JSON_PROPERTY_NATIONALITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationality(String nationality) { @@ -1213,6 +1362,11 @@ public String getOrderReference() { } + /** + * When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + * + * @param orderReference + */ @JsonProperty(JSON_PROPERTY_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderReference(String orderReference) { @@ -1238,6 +1392,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -1263,6 +1422,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -1288,6 +1452,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1313,6 +1482,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1338,6 +1512,11 @@ public String getSelectedBrand() { } + /** + * Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card. + * + * @param selectedBrand + */ @JsonProperty(JSON_PROPERTY_SELECTED_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedBrand(String selectedBrand) { @@ -1363,6 +1542,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -1388,6 +1572,11 @@ public String getSessionId() { } + /** + * A session ID used to identify a payment session. + * + * @param sessionId + */ @JsonProperty(JSON_PROPERTY_SESSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionId(String sessionId) { @@ -1413,6 +1602,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1438,6 +1632,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1463,6 +1662,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1488,6 +1692,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1513,6 +1722,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1538,6 +1752,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1563,6 +1782,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1588,6 +1812,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1621,6 +1850,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1646,6 +1880,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1671,6 +1910,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1696,6 +1940,11 @@ public ThreeDS2RequestData getThreeDS2RequestData() { } + /** + * threeDS2RequestData + * + * @param threeDS2RequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData) { @@ -1721,6 +1970,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) { @@ -1746,6 +2000,11 @@ public String getTotalsGroup() { } + /** + * The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). + * + * @param totalsGroup + */ @JsonProperty(JSON_PROPERTY_TOTALS_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalsGroup(String totalsGroup) { @@ -1771,6 +2030,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { diff --git a/src/main/java/com/adyen/model/payment/PaymentRequest3d.java b/src/main/java/com/adyen/model/payment/PaymentRequest3d.java index e00a712af..da72f4d13 100644 --- a/src/main/java/com/adyen/model/payment/PaymentRequest3d.java +++ b/src/main/java/com/adyen/model/payment/PaymentRequest3d.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -330,6 +329,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -355,6 +359,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -388,6 +397,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -413,6 +427,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -438,6 +457,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -463,6 +487,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -488,6 +517,11 @@ public BrowserInfo getBrowserInfo() { } + /** + * browserInfo + * + * @param browserInfo + */ @JsonProperty(JSON_PROPERTY_BROWSER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrowserInfo(BrowserInfo browserInfo) { @@ -513,6 +547,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -538,6 +577,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -563,6 +607,11 @@ public ForexQuote getDccQuote() { } + /** + * dccQuote + * + * @param dccQuote + */ @JsonProperty(JSON_PROPERTY_DCC_QUOTE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccQuote(ForexQuote dccQuote) { @@ -588,6 +637,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -613,6 +667,11 @@ public OffsetDateTime getDeliveryDate() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliveryDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryDate(OffsetDateTime deliveryDate) { @@ -638,6 +697,11 @@ public String getDeviceFingerprint() { } + /** + * A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + * + * @param deviceFingerprint + */ @JsonProperty(JSON_PROPERTY_DEVICE_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceFingerprint(String deviceFingerprint) { @@ -663,6 +727,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -688,6 +757,11 @@ public Installments getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Installments installments) { @@ -721,6 +795,11 @@ public Map getLocalizedShopperStatement() { } + /** + * The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. + * + * @param localizedShopperStatement + */ @JsonProperty(JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalizedShopperStatement(Map localizedShopperStatement) { @@ -746,6 +825,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -771,6 +855,11 @@ public String getMd() { } + /** + * The payment session identifier returned by the card issuer. + * + * @param md + */ @JsonProperty(JSON_PROPERTY_MD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMd(String md) { @@ -796,6 +885,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -821,6 +915,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -846,6 +945,11 @@ public MerchantRiskIndicator getMerchantRiskIndicator() { } + /** + * merchantRiskIndicator + * + * @param merchantRiskIndicator + */ @JsonProperty(JSON_PROPERTY_MERCHANT_RISK_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) { @@ -879,6 +983,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -904,6 +1013,11 @@ public String getOrderReference() { } + /** + * When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + * + * @param orderReference + */ @JsonProperty(JSON_PROPERTY_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderReference(String orderReference) { @@ -929,6 +1043,11 @@ public String getPaResponse() { } + /** + * Payment authorisation response returned by the card issuer. The `paResponse` field holds the PaRes value received from the card issuer. + * + * @param paResponse + */ @JsonProperty(JSON_PROPERTY_PA_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaResponse(String paResponse) { @@ -954,6 +1073,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -979,6 +1103,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1004,6 +1133,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -1029,6 +1163,11 @@ public String getSelectedBrand() { } + /** + * Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card. + * + * @param selectedBrand + */ @JsonProperty(JSON_PROPERTY_SELECTED_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedBrand(String selectedBrand) { @@ -1054,6 +1193,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -1079,6 +1223,11 @@ public String getSessionId() { } + /** + * A session ID used to identify a payment session. + * + * @param sessionId + */ @JsonProperty(JSON_PROPERTY_SESSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionId(String sessionId) { @@ -1104,6 +1253,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1129,6 +1283,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1154,6 +1313,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1179,6 +1343,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1204,6 +1373,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1229,6 +1403,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1254,6 +1433,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1279,6 +1463,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1312,6 +1501,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1337,6 +1531,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1362,6 +1561,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1387,6 +1591,11 @@ public ThreeDS2RequestData getThreeDS2RequestData() { } + /** + * threeDS2RequestData + * + * @param threeDS2RequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData) { @@ -1412,6 +1621,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) { @@ -1437,6 +1651,11 @@ public String getTotalsGroup() { } + /** + * The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). + * + * @param totalsGroup + */ @JsonProperty(JSON_PROPERTY_TOTALS_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalsGroup(String totalsGroup) { @@ -1462,6 +1681,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { diff --git a/src/main/java/com/adyen/model/payment/PaymentRequest3ds2.java b/src/main/java/com/adyen/model/payment/PaymentRequest3ds2.java index 5997b6fed..b7cec07ad 100644 --- a/src/main/java/com/adyen/model/payment/PaymentRequest3ds2.java +++ b/src/main/java/com/adyen/model/payment/PaymentRequest3ds2.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -331,6 +330,11 @@ public AccountInfo getAccountInfo() { } + /** + * accountInfo + * + * @param accountInfo + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountInfo(AccountInfo accountInfo) { @@ -356,6 +360,11 @@ public Amount getAdditionalAmount() { } + /** + * additionalAmount + * + * @param additionalAmount + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalAmount(Amount additionalAmount) { @@ -389,6 +398,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payment request. The `additionalData` object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -414,6 +428,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -439,6 +458,11 @@ public ApplicationInfo getApplicationInfo() { } + /** + * applicationInfo + * + * @param applicationInfo + */ @JsonProperty(JSON_PROPERTY_APPLICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setApplicationInfo(ApplicationInfo applicationInfo) { @@ -464,6 +488,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -489,6 +518,11 @@ public BrowserInfo getBrowserInfo() { } + /** + * browserInfo + * + * @param browserInfo + */ @JsonProperty(JSON_PROPERTY_BROWSER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBrowserInfo(BrowserInfo browserInfo) { @@ -514,6 +548,11 @@ public Integer getCaptureDelayHours() { } + /** + * The delay between the authorisation and scheduled auto-capture, specified in hours. + * + * @param captureDelayHours + */ @JsonProperty(JSON_PROPERTY_CAPTURE_DELAY_HOURS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCaptureDelayHours(Integer captureDelayHours) { @@ -539,6 +578,11 @@ public LocalDate getDateOfBirth() { } + /** + * The shopper's date of birth. Format [ISO-8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DD + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -564,6 +608,11 @@ public ForexQuote getDccQuote() { } + /** + * dccQuote + * + * @param dccQuote + */ @JsonProperty(JSON_PROPERTY_DCC_QUOTE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccQuote(ForexQuote dccQuote) { @@ -589,6 +638,11 @@ public Address getDeliveryAddress() { } + /** + * deliveryAddress + * + * @param deliveryAddress + */ @JsonProperty(JSON_PROPERTY_DELIVERY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryAddress(Address deliveryAddress) { @@ -614,6 +668,11 @@ public OffsetDateTime getDeliveryDate() { } + /** + * The date and time the purchased goods should be delivered. Format [ISO 8601](https://www.w3.org/TR/NOTE-datetime): YYYY-MM-DDThh:mm:ss.sssTZD Example: 2017-07-17T13:42:40.428+01:00 + * + * @param deliveryDate + */ @JsonProperty(JSON_PROPERTY_DELIVERY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeliveryDate(OffsetDateTime deliveryDate) { @@ -639,6 +698,11 @@ public String getDeviceFingerprint() { } + /** + * A string containing the shopper's device fingerprint. For more information, refer to [Device fingerprinting](https://docs.adyen.com/risk-management/device-fingerprinting). + * + * @param deviceFingerprint + */ @JsonProperty(JSON_PROPERTY_DEVICE_FINGERPRINT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceFingerprint(String deviceFingerprint) { @@ -664,6 +728,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -689,6 +758,11 @@ public Installments getInstallments() { } + /** + * installments + * + * @param installments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallments(Installments installments) { @@ -722,6 +796,11 @@ public Map getLocalizedShopperStatement() { } + /** + * The `localizedShopperStatement` field lets you use dynamic values for your shopper statement in a local character set. If not supplied, left empty, or for cross-border transactions, **shopperStatement** is used. Adyen currently supports the ja-Kana character set for Visa and Mastercard payments in Japan using Japanese cards. This character set supports: * UTF-8 based Katakana, capital letters, numbers and special characters. * Half-width or full-width characters. + * + * @param localizedShopperStatement + */ @JsonProperty(JSON_PROPERTY_LOCALIZED_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocalizedShopperStatement(Map localizedShopperStatement) { @@ -747,6 +826,11 @@ public String getMcc() { } + /** + * The [merchant category code](https://en.wikipedia.org/wiki/Merchant_category_code) (MCC) is a four-digit number, which relates to a particular market segment. This code reflects the predominant activity that is conducted by the merchant. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -772,6 +856,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -797,6 +886,11 @@ public String getMerchantOrderReference() { } + /** + * This reference allows linking multiple transactions to each other for reporting purposes (i.e. order auth-rate). The reference should be unique per billing cycle. The same merchant order reference should never be reused after the first authorised attempt. If used, this field should be supplied for all incoming authorisations. > We strongly recommend you send the `merchantOrderReference` value to benefit from linking payment requests when authorisation retries take place. In addition, we recommend you provide `retry.orderAttemptNumber`, `retry.chainAttemptNumber`, and `retry.skipRetry` values in `PaymentRequest.additionalData`. + * + * @param merchantOrderReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantOrderReference(String merchantOrderReference) { @@ -822,6 +916,11 @@ public MerchantRiskIndicator getMerchantRiskIndicator() { } + /** + * merchantRiskIndicator + * + * @param merchantRiskIndicator + */ @JsonProperty(JSON_PROPERTY_MERCHANT_RISK_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantRiskIndicator(MerchantRiskIndicator merchantRiskIndicator) { @@ -855,6 +954,11 @@ public Map getMetadata() { } + /** + * Metadata consists of entries, each of which includes a key and a value. Limits: * Maximum 20 key-value pairs per request. When exceeding, the \"177\" error occurs: \"Metadata size exceeds limit\". * Maximum 20 characters per key. * Maximum 80 characters per value. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -880,6 +984,11 @@ public String getOrderReference() { } + /** + * When you are doing multiple partial (gift card) payments, this is the `pspReference` of the first payment. We use this to link the multiple payments to each other. As your own reference for linking multiple payments, use the `merchantOrderReference`instead. + * + * @param orderReference + */ @JsonProperty(JSON_PROPERTY_ORDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOrderReference(String orderReference) { @@ -905,6 +1014,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -930,6 +1044,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * Defines a recurring payment type. Required when creating a token to store payment details or using stored payment details. Allowed values: * `Subscription` – A transaction for a fixed or variable amount, which follows a fixed schedule. * `CardOnFile` – With a card-on-file (CoF) transaction, card details are stored to enable one-click or omnichannel journeys, or simply to streamline the checkout process. Any subscription not following a fixed schedule is also considered a card-on-file transaction. * `UnscheduledCardOnFile` – An unscheduled card-on-file (UCoF) transaction is a transaction that occurs on a non-fixed schedule and/or have variable amounts. For example, automatic top-ups when a cardholder's balance drops below a certain amount. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -955,6 +1074,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -980,6 +1104,11 @@ public String getSelectedBrand() { } + /** + * Some payment methods require defining a value for this field to specify how to process the transaction. For the Bancontact payment method, it can be set to: * `maestro` (default), to be processed like a Maestro card, or * `bcmc`, to be processed like a Bancontact card. + * + * @param selectedBrand + */ @JsonProperty(JSON_PROPERTY_SELECTED_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedBrand(String selectedBrand) { @@ -1005,6 +1134,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -1030,6 +1164,11 @@ public String getSessionId() { } + /** + * A session ID used to identify a payment session. + * + * @param sessionId + */ @JsonProperty(JSON_PROPERTY_SESSION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSessionId(String sessionId) { @@ -1055,6 +1194,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -1080,6 +1224,11 @@ public String getShopperIP() { } + /** + * The shopper's IP address. In general, we recommend that you provide this data, as it is used in a number of risk checks (for instance, number of payment attempts or location-based checks). > For 3D Secure 2 transactions, schemes require `shopperIP` for all browser-based implementations. This field is also mandatory for some merchants depending on your business model. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param shopperIP + */ @JsonProperty(JSON_PROPERTY_SHOPPER_I_P) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperIP(String shopperIP) { @@ -1105,6 +1254,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -1130,6 +1284,11 @@ public String getShopperLocale() { } + /** + * The combination of a language code and a country code to specify the language to be used in the payment. + * + * @param shopperLocale + */ @JsonProperty(JSON_PROPERTY_SHOPPER_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperLocale(String shopperLocale) { @@ -1155,6 +1314,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -1180,6 +1344,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1205,6 +1374,11 @@ public String getShopperStatement() { } + /** + * The text to be shown on the shopper's bank statement. We recommend sending a maximum of 22 characters, otherwise banks might truncate the string. Allowed characters: **a-z**, **A-Z**, **0-9**, spaces, and special characters **. , ' _ - ? + * /_**. + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -1230,6 +1404,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -1263,6 +1442,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -1288,6 +1472,11 @@ public String getStore() { } + /** + * The ecommerce or point-of-sale store that is processing the payment. Used in: * [Partner platform integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for the [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic). * [Platform setup integrations](https://docs.adyen.com/marketplaces-and-platforms/additional-for-platform-setup/route-payment-to-store) for the [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms). + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -1313,6 +1502,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { @@ -1338,6 +1532,11 @@ public ThreeDS2RequestData getThreeDS2RequestData() { } + /** + * threeDS2RequestData + * + * @param threeDS2RequestData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_REQUEST_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2RequestData(ThreeDS2RequestData threeDS2RequestData) { @@ -1363,6 +1562,11 @@ public ThreeDS2Result getThreeDS2Result() { } + /** + * threeDS2Result + * + * @param threeDS2Result + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Result(ThreeDS2Result threeDS2Result) { @@ -1388,6 +1592,11 @@ public String getThreeDS2Token() { } + /** + * The ThreeDS2Token that was returned in the /authorise call. + * + * @param threeDS2Token + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Token(String threeDS2Token) { @@ -1413,6 +1622,11 @@ public Boolean getThreeDSAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param threeDSAuthenticationOnly + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSAuthenticationOnly(Boolean threeDSAuthenticationOnly) { @@ -1438,6 +1652,11 @@ public String getTotalsGroup() { } + /** + * The reference value to aggregate sales totals in reporting. When not specified, the store field is used (if available). + * + * @param totalsGroup + */ @JsonProperty(JSON_PROPERTY_TOTALS_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotalsGroup(String totalsGroup) { @@ -1463,6 +1682,11 @@ public Boolean getTrustedShopper() { } + /** + * Set to true if the payment should be routed to a trusted MID. + * + * @param trustedShopper + */ @JsonProperty(JSON_PROPERTY_TRUSTED_SHOPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTrustedShopper(Boolean trustedShopper) { diff --git a/src/main/java/com/adyen/model/payment/PaymentResult.java b/src/main/java/com/adyen/model/payment/PaymentResult.java index b0be88f42..7a49a84c9 100644 --- a/src/main/java/com/adyen/model/payment/PaymentResult.java +++ b/src/main/java/com/adyen/model/payment/PaymentResult.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -172,6 +171,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -197,6 +201,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -222,6 +231,11 @@ public Amount getDccAmount() { } + /** + * dccAmount + * + * @param dccAmount + */ @JsonProperty(JSON_PROPERTY_DCC_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccAmount(Amount dccAmount) { @@ -247,6 +261,11 @@ public String getDccSignature() { } + /** + * Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param dccSignature + */ @JsonProperty(JSON_PROPERTY_DCC_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccSignature(String dccSignature) { @@ -272,6 +291,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -297,6 +321,11 @@ public String getIssuerUrl() { } + /** + * The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL. + * + * @param issuerUrl + */ @JsonProperty(JSON_PROPERTY_ISSUER_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerUrl(String issuerUrl) { @@ -322,6 +351,11 @@ public String getMd() { } + /** + * The payment session. + * + * @param md + */ @JsonProperty(JSON_PROPERTY_MD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMd(String md) { @@ -347,6 +381,11 @@ public String getPaRequest() { } + /** + * The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). + * + * @param paRequest + */ @JsonProperty(JSON_PROPERTY_PA_REQUEST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaRequest(String paRequest) { @@ -372,6 +411,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -397,6 +441,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -422,6 +471,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { diff --git a/src/main/java/com/adyen/model/payment/Phone.java b/src/main/java/com/adyen/model/payment/Phone.java index a743399ef..f17206e6e 100644 --- a/src/main/java/com/adyen/model/payment/Phone.java +++ b/src/main/java/com/adyen/model/payment/Phone.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getCc() { } + /** + * Country code. Length: 1–3 characters. + * + * @param cc + */ @JsonProperty(JSON_PROPERTY_CC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCc(String cc) { @@ -89,6 +93,11 @@ public String getSubscriber() { } + /** + * Subscriber number. Maximum length: 15 characters. + * + * @param subscriber + */ @JsonProperty(JSON_PROPERTY_SUBSCRIBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSubscriber(String subscriber) { diff --git a/src/main/java/com/adyen/model/payment/PlatformChargebackLogic.java b/src/main/java/com/adyen/model/payment/PlatformChargebackLogic.java index 6683b92ff..8a510298a 100644 --- a/src/main/java/com/adyen/model/payment/PlatformChargebackLogic.java +++ b/src/main/java/com/adyen/model/payment/PlatformChargebackLogic.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -105,6 +104,11 @@ public BehaviorEnum getBehavior() { } + /** + * The method of handling the chargeback. Possible values: **deductFromLiableAccount**, **deductFromOneBalanceAccount**, **deductAccordingToSplitRatio**. + * + * @param behavior + */ @JsonProperty(JSON_PROPERTY_BEHAVIOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBehavior(BehaviorEnum behavior) { @@ -130,6 +134,11 @@ public String getCostAllocationAccount() { } + /** + * The unique identifier of the balance account to which the chargeback fees are booked. By default, the chargeback fees are booked to your liable balance account. + * + * @param costAllocationAccount + */ @JsonProperty(JSON_PROPERTY_COST_ALLOCATION_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCostAllocationAccount(String costAllocationAccount) { @@ -155,6 +164,11 @@ public String getTargetAccount() { } + /** + * The unique identifier of the balance account against which the disputed amount is booked. Required if `behavior` is **deductFromOneBalanceAccount**. + * + * @param targetAccount + */ @JsonProperty(JSON_PROPERTY_TARGET_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTargetAccount(String targetAccount) { diff --git a/src/main/java/com/adyen/model/payment/Recurring.java b/src/main/java/com/adyen/model/payment/Recurring.java index 391aefd8a..52ec83547 100644 --- a/src/main/java/com/adyen/model/payment/Recurring.java +++ b/src/main/java/com/adyen/model/payment/Recurring.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -153,6 +152,11 @@ public ContractEnum getContract() { } + /** + * The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts). + * + * @param contract + */ @JsonProperty(JSON_PROPERTY_CONTRACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContract(ContractEnum contract) { @@ -178,6 +182,11 @@ public String getRecurringDetailName() { } + /** + * A descriptive name for this detail. + * + * @param recurringDetailName + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailName(String recurringDetailName) { @@ -203,6 +212,11 @@ public OffsetDateTime getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(OffsetDateTime recurringExpiry) { @@ -228,6 +242,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -253,6 +272,11 @@ public TokenServiceEnum getTokenService() { } + /** + * The name of the token service. + * + * @param tokenService + */ @JsonProperty(JSON_PROPERTY_TOKEN_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenService(TokenServiceEnum tokenService) { diff --git a/src/main/java/com/adyen/model/payment/RefundRequest.java b/src/main/java/com/adyen/model/payment/RefundRequest.java index b95a93ef4..203c37c2a 100644 --- a/src/main/java/com/adyen/model/payment/RefundRequest.java +++ b/src/main/java/com/adyen/model/payment/RefundRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -116,6 +115,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -141,6 +145,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -166,6 +175,11 @@ public Amount getModificationAmount() { } + /** + * modificationAmount + * + * @param modificationAmount + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationAmount(Amount modificationAmount) { @@ -191,6 +205,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -216,6 +235,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -241,6 +265,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -266,6 +295,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -291,6 +325,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -324,6 +363,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -349,6 +393,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -374,6 +423,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalData3DSecure.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalData3DSecure.java index c60653593..d3c9f1100 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalData3DSecure.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalData3DSecure.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -76,6 +75,11 @@ public String getCardHolderInfo() { } + /** + * Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. + * + * @param cardHolderInfo + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderInfo(String cardHolderInfo) { @@ -101,6 +105,11 @@ public String getCavv() { } + /** + * The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array. + * + * @param cavv + */ @JsonProperty(JSON_PROPERTY_CAVV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavv(String cavv) { @@ -126,6 +135,11 @@ public String getCavvAlgorithm() { } + /** + * The CAVV algorithm used. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -151,6 +165,11 @@ public String getScaExemptionRequested() { } + /** + * Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + * + * @param scaExemptionRequested + */ @JsonProperty(JSON_PROPERTY_SCA_EXEMPTION_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScaExemptionRequested(String scaExemptionRequested) { @@ -176,6 +195,11 @@ public Boolean getThreeds2CardEnrolled() { } + /** + * Indicates whether a card is enrolled for 3D Secure 2. + * + * @param threeds2CardEnrolled + */ @JsonProperty(JSON_PROPERTY_THREEDS2_CARD_ENROLLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeds2CardEnrolled(Boolean threeds2CardEnrolled) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataBillingAddress.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataBillingAddress.java index 8079aa8f5..7ae5d2dae 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataBillingAddress.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataBillingAddress.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -80,6 +79,11 @@ public String getBillingAddressCity() { } + /** + * The billing address city passed in the payment request. + * + * @param billingAddressCity + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressCity(String billingAddressCity) { @@ -105,6 +109,11 @@ public String getBillingAddressCountry() { } + /** + * The billing address country passed in the payment request. Example: NL + * + * @param billingAddressCountry + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressCountry(String billingAddressCountry) { @@ -130,6 +139,11 @@ public String getBillingAddressHouseNumberOrName() { } + /** + * The billing address house number or name passed in the payment request. + * + * @param billingAddressHouseNumberOrName + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressHouseNumberOrName(String billingAddressHouseNumberOrName) { @@ -155,6 +169,11 @@ public String getBillingAddressPostalCode() { } + /** + * The billing address postal code passed in the payment request. Example: 1011 DJ + * + * @param billingAddressPostalCode + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressPostalCode(String billingAddressPostalCode) { @@ -180,6 +199,11 @@ public String getBillingAddressStateOrProvince() { } + /** + * The billing address state or province passed in the payment request. Example: NH + * + * @param billingAddressStateOrProvince + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressStateOrProvince(String billingAddressStateOrProvince) { @@ -205,6 +229,11 @@ public String getBillingAddressStreet() { } + /** + * The billing address street passed in the payment request. + * + * @param billingAddressStreet + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressStreet(String billingAddressStreet) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCard.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCard.java index b2b26736e..a8ce0366c 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCard.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCard.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -88,6 +87,11 @@ public String getCardBin() { } + /** + * The first six digits of the card number. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN. Example: 521234 + * + * @param cardBin + */ @JsonProperty(JSON_PROPERTY_CARD_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardBin(String cardBin) { @@ -113,6 +117,11 @@ public String getCardHolderName() { } + /** + * The cardholder name passed in the payment request. + * + * @param cardHolderName + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderName(String cardHolderName) { @@ -138,6 +147,11 @@ public String getCardIssuingBank() { } + /** + * The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available. + * + * @param cardIssuingBank + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingBank(String cardIssuingBank) { @@ -163,6 +177,11 @@ public String getCardIssuingCountry() { } + /** + * The country where the card was issued. Example: US + * + * @param cardIssuingCountry + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingCountry(String cardIssuingCountry) { @@ -188,6 +207,11 @@ public String getCardIssuingCurrency() { } + /** + * The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. Example: USD + * + * @param cardIssuingCurrency + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingCurrency(String cardIssuingCurrency) { @@ -213,6 +237,11 @@ public String getCardPaymentMethod() { } + /** + * The card payment method used for the transaction. Example: amex + * + * @param cardPaymentMethod + */ @JsonProperty(JSON_PROPERTY_CARD_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardPaymentMethod(String cardPaymentMethod) { @@ -238,6 +267,11 @@ public String getCardSummary() { } + /** + * The last four digits of a card number. > Returned only in case of a card payment. + * + * @param cardSummary + */ @JsonProperty(JSON_PROPERTY_CARD_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardSummary(String cardSummary) { @@ -263,6 +297,11 @@ public String getIssuerBin() { } + /** + * The first eight digits of the card number. Only returned if the card number is 16 digits or more. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN. Example: 52123423 + * + * @param issuerBin + */ @JsonProperty(JSON_PROPERTY_ISSUER_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerBin(String issuerBin) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCommon.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCommon.java index 9a05a232c..b0785a6f3 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCommon.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataCommon.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -364,6 +363,11 @@ public String getAcquirerAccountCode() { } + /** + * The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. + * + * @param acquirerAccountCode + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerAccountCode(String acquirerAccountCode) { @@ -389,6 +393,11 @@ public String getAcquirerCode() { } + /** + * The name of the acquirer processing the payment request. Example: TestPmmAcquirer + * + * @param acquirerCode + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerCode(String acquirerCode) { @@ -414,6 +423,11 @@ public String getAcquirerReference() { } + /** + * The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9 + * + * @param acquirerReference + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerReference(String acquirerReference) { @@ -439,6 +453,11 @@ public String getAlias() { } + /** + * The Adyen alias of the card. Example: H167852639363479 + * + * @param alias + */ @JsonProperty(JSON_PROPERTY_ALIAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlias(String alias) { @@ -464,6 +483,11 @@ public String getAliasType() { } + /** + * The type of the card alias. Example: Default + * + * @param aliasType + */ @JsonProperty(JSON_PROPERTY_ALIAS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAliasType(String aliasType) { @@ -489,6 +513,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. Example: 58747 + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -514,6 +543,11 @@ public String getAuthorisationMid() { } + /** + * Merchant ID known by the acquirer. + * + * @param authorisationMid + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_MID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationMid(String authorisationMid) { @@ -539,6 +573,11 @@ public String getAuthorisedAmountCurrency() { } + /** + * The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param authorisedAmountCurrency + */ @JsonProperty(JSON_PROPERTY_AUTHORISED_AMOUNT_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisedAmountCurrency(String authorisedAmountCurrency) { @@ -564,6 +603,11 @@ public String getAuthorisedAmountValue() { } + /** + * Value of the amount authorised. This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + * + * @param authorisedAmountValue + */ @JsonProperty(JSON_PROPERTY_AUTHORISED_AMOUNT_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisedAmountValue(String authorisedAmountValue) { @@ -589,6 +633,11 @@ public String getAvsResult() { } + /** + * The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + * + * @param avsResult + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResult(String avsResult) { @@ -614,6 +663,11 @@ public String getAvsResultRaw() { } + /** + * Raw AVS result received from the acquirer, where available. Example: D + * + * @param avsResultRaw + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResultRaw(String avsResultRaw) { @@ -639,6 +693,11 @@ public String getBic() { } + /** + * BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -664,6 +723,11 @@ public String getCoBrandedWith() { } + /** + * Includes the co-branded card information. + * + * @param coBrandedWith + */ @JsonProperty(JSON_PROPERTY_CO_BRANDED_WITH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCoBrandedWith(String coBrandedWith) { @@ -689,6 +753,11 @@ public String getCvcResult() { } + /** + * The result of CVC verification. + * + * @param cvcResult + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResult(String cvcResult) { @@ -714,6 +783,11 @@ public String getCvcResultRaw() { } + /** + * The raw result of CVC verification. + * + * @param cvcResultRaw + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResultRaw(String cvcResultRaw) { @@ -739,6 +813,11 @@ public String getDsTransID() { } + /** + * Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -764,6 +843,11 @@ public String getEci() { } + /** + * The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02 + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -789,6 +873,11 @@ public String getExpiryDate() { } + /** + * The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. + * + * @param expiryDate + */ @JsonProperty(JSON_PROPERTY_EXPIRY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryDate(String expiryDate) { @@ -814,6 +903,11 @@ public String getExtraCostsCurrency() { } + /** + * The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR + * + * @param extraCostsCurrency + */ @JsonProperty(JSON_PROPERTY_EXTRA_COSTS_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtraCostsCurrency(String extraCostsCurrency) { @@ -839,6 +933,11 @@ public String getExtraCostsValue() { } + /** + * The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units. + * + * @param extraCostsValue + */ @JsonProperty(JSON_PROPERTY_EXTRA_COSTS_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtraCostsValue(String extraCostsValue) { @@ -864,6 +963,11 @@ public String getFraudCheckItemNrFraudCheckname() { } + /** + * The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. + * + * @param fraudCheckItemNrFraudCheckname + */ @JsonProperty(JSON_PROPERTY_FRAUD_CHECK_ITEM_NR_FRAUD_CHECKNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudCheckItemNrFraudCheckname(String fraudCheckItemNrFraudCheckname) { @@ -889,6 +993,11 @@ public String getFraudManualReview() { } + /** + * Indicates if the payment is sent to manual review. + * + * @param fraudManualReview + */ @JsonProperty(JSON_PROPERTY_FRAUD_MANUAL_REVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudManualReview(String fraudManualReview) { @@ -914,6 +1023,11 @@ public FraudResultTypeEnum getFraudResultType() { } + /** + * The fraud result properties of the payment. + * + * @param fraudResultType + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResultType(FraudResultTypeEnum fraudResultType) { @@ -939,6 +1053,11 @@ public String getFundingSource() { } + /** + * Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(String fundingSource) { @@ -964,6 +1083,11 @@ public String getFundsAvailability() { } + /** + * Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\". + * + * @param fundsAvailability + */ @JsonProperty(JSON_PROPERTY_FUNDS_AVAILABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundsAvailability(String fundsAvailability) { @@ -989,6 +1113,11 @@ public String getInferredRefusalReason() { } + /** + * Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card + * + * @param inferredRefusalReason + */ @JsonProperty(JSON_PROPERTY_INFERRED_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInferredRefusalReason(String inferredRefusalReason) { @@ -1014,6 +1143,11 @@ public String getIsCardCommercial() { } + /** + * Indicates if the card is used for business purposes only. + * + * @param isCardCommercial + */ @JsonProperty(JSON_PROPERTY_IS_CARD_COMMERCIAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCardCommercial(String isCardCommercial) { @@ -1039,6 +1173,11 @@ public String getIssuerCountry() { } + /** + * The issuing country of the card based on the BIN list that Adyen maintains. Example: JP + * + * @param issuerCountry + */ @JsonProperty(JSON_PROPERTY_ISSUER_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerCountry(String issuerCountry) { @@ -1064,6 +1203,11 @@ public String getLiabilityShift() { } + /** + * A Boolean value indicating whether a liability shift was offered for this payment. + * + * @param liabilityShift + */ @JsonProperty(JSON_PROPERTY_LIABILITY_SHIFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLiabilityShift(String liabilityShift) { @@ -1089,6 +1233,11 @@ public String getMcBankNetReferenceNumber() { } + /** + * The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. + * + * @param mcBankNetReferenceNumber + */ @JsonProperty(JSON_PROPERTY_MC_BANK_NET_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcBankNetReferenceNumber(String mcBankNetReferenceNumber) { @@ -1114,6 +1263,11 @@ public String getMerchantAdviceCode() { } + /** + * The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes). + * + * @param merchantAdviceCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ADVICE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAdviceCode(String merchantAdviceCode) { @@ -1139,6 +1293,11 @@ public String getMerchantReference() { } + /** + * The reference provided for the transaction. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -1164,6 +1323,11 @@ public String getNetworkTxReference() { } + /** + * Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -1189,6 +1353,11 @@ public String getOwnerName() { } + /** + * The owner name of a bank account. Only relevant for SEPA Direct Debit transactions. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -1214,6 +1383,11 @@ public String getPaymentAccountReference() { } + /** + * The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters. + * + * @param paymentAccountReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountReference(String paymentAccountReference) { @@ -1239,6 +1413,11 @@ public String getPaymentMethod() { } + /** + * The payment method used in the transaction. + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -1264,6 +1443,11 @@ public String getPaymentMethodVariant() { } + /** + * The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro + * + * @param paymentMethodVariant + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodVariant(String paymentMethodVariant) { @@ -1289,6 +1473,11 @@ public String getPayoutEligible() { } + /** + * Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) + * + * @param payoutEligible + */ @JsonProperty(JSON_PROPERTY_PAYOUT_ELIGIBLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayoutEligible(String payoutEligible) { @@ -1314,6 +1503,11 @@ public String getRealtimeAccountUpdaterStatus() { } + /** + * The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder + * + * @param realtimeAccountUpdaterStatus + */ @JsonProperty(JSON_PROPERTY_REALTIME_ACCOUNT_UPDATER_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRealtimeAccountUpdaterStatus(String realtimeAccountUpdaterStatus) { @@ -1339,6 +1533,11 @@ public String getReceiptFreeText() { } + /** + * Message to be displayed on the terminal. + * + * @param receiptFreeText + */ @JsonProperty(JSON_PROPERTY_RECEIPT_FREE_TEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceiptFreeText(String receiptFreeText) { @@ -1364,6 +1563,11 @@ public String getRecurringContractTypes() { } + /** + * The recurring contract types applicable to the transaction. + * + * @param recurringContractTypes + */ @JsonProperty(JSON_PROPERTY_RECURRING_CONTRACT_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringContractTypes(String recurringContractTypes) { @@ -1389,6 +1593,11 @@ public String getRecurringFirstPspReference() { } + /** + * The `pspReference`, of the first recurring payment that created the recurring detail. This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + * + * @param recurringFirstPspReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_FIRST_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFirstPspReference(String recurringFirstPspReference) { @@ -1414,6 +1623,11 @@ public String getRecurringRecurringDetailReference() { } + /** + * The reference that uniquely identifies the recurring transaction. + * + * @param recurringRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringRecurringDetailReference(String recurringRecurringDetailReference) { @@ -1439,6 +1653,11 @@ public String getRecurringShopperReference() { } + /** + * The provided reference of the shopper for a recurring transaction. + * + * @param recurringShopperReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringShopperReference(String recurringShopperReference) { @@ -1464,6 +1683,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * The processing model used for the recurring transaction. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1489,6 +1713,11 @@ public String getReferred() { } + /** + * If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true + * + * @param referred + */ @JsonProperty(JSON_PROPERTY_REFERRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReferred(String referred) { @@ -1514,6 +1743,11 @@ public String getRefusalReasonRaw() { } + /** + * Raw refusal reason received from the acquirer, where available. Example: AUTHORISED + * + * @param refusalReasonRaw + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReasonRaw(String refusalReasonRaw) { @@ -1539,6 +1773,11 @@ public String getRequestAmount() { } + /** + * The amount of the payment request. + * + * @param requestAmount + */ @JsonProperty(JSON_PROPERTY_REQUEST_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestAmount(String requestAmount) { @@ -1564,6 +1803,11 @@ public String getRequestCurrencyCode() { } + /** + * The currency of the payment request. + * + * @param requestCurrencyCode + */ @JsonProperty(JSON_PROPERTY_REQUEST_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestCurrencyCode(String requestCurrencyCode) { @@ -1589,6 +1833,11 @@ public String getShopperInteraction() { } + /** + * The shopper interaction type of the payment request. Example: Ecommerce + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(String shopperInteraction) { @@ -1614,6 +1863,11 @@ public String getShopperReference() { } + /** + * The shopperReference passed in the payment request. Example: AdyenTestShopperXX + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1639,6 +1893,11 @@ public String getTerminalId() { } + /** + * The terminal ID used in a point-of-sale payment. Example: 06022622 + * + * @param terminalId + */ @JsonProperty(JSON_PROPERTY_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalId(String terminalId) { @@ -1664,6 +1923,11 @@ public String getThreeDAuthenticated() { } + /** + * A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true + * + * @param threeDAuthenticated + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticated(String threeDAuthenticated) { @@ -1689,6 +1953,11 @@ public String getThreeDAuthenticatedResponse() { } + /** + * The raw 3DS authentication result from the card issuer. Example: N + * + * @param threeDAuthenticatedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticatedResponse(String threeDAuthenticatedResponse) { @@ -1714,6 +1983,11 @@ public String getThreeDOffered() { } + /** + * A Boolean value indicating whether 3DS was offered for this payment. Example: true + * + * @param threeDOffered + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOffered(String threeDOffered) { @@ -1739,6 +2013,11 @@ public String getThreeDOfferedResponse() { } + /** + * The raw enrollment result from the 3DS directory services of the card schemes. Example: Y + * + * @param threeDOfferedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOfferedResponse(String threeDOfferedResponse) { @@ -1764,6 +2043,11 @@ public String getThreeDSVersion() { } + /** + * The 3D Secure 2 version. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { @@ -1789,6 +2073,11 @@ public String getVisaTransactionId() { } + /** + * The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. + * + * @param visaTransactionId + */ @JsonProperty(JSON_PROPERTY_VISA_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisaTransactionId(String visaTransactionId) { @@ -1814,6 +2103,11 @@ public String getXid() { } + /** + * The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + * + * @param xid + */ @JsonProperty(JSON_PROPERTY_XID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setXid(String xid) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataDomesticError.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataDomesticError.java index 166d7894b..bc65ed4d3 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataDomesticError.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataDomesticError.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getDomesticRefusalReasonRaw() { } + /** + * The reason the transaction was declined, given by the local issuer. Currently available for merchants in Japan. + * + * @param domesticRefusalReasonRaw + */ @JsonProperty(JSON_PROPERTY_DOMESTIC_REFUSAL_REASON_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomesticRefusalReasonRaw(String domesticRefusalReasonRaw) { @@ -89,6 +93,11 @@ public String getDomesticShopperAdvice() { } + /** + * The action the shopper should take, in a local language. Currently available in Japanese, for merchants in Japan. + * + * @param domesticShopperAdvice + */ @JsonProperty(JSON_PROPERTY_DOMESTIC_SHOPPER_ADVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomesticShopperAdvice(String domesticShopperAdvice) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataInstallments.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataInstallments.java index 6e3a15419..2f44481d0 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataInstallments.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataInstallments.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -104,6 +103,11 @@ public String getInstallmentPaymentDataInstallmentType() { } + /** + * Type of installment. The value of `installmentType` should be **IssuerFinanced**. + * + * @param installmentPaymentDataInstallmentType + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_INSTALLMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataInstallmentType(String installmentPaymentDataInstallmentType) { @@ -129,6 +133,11 @@ public String getInstallmentPaymentDataOptionItemNrAnnualPercentageRate() { } + /** + * Annual interest rate. + * + * @param installmentPaymentDataOptionItemNrAnnualPercentageRate + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_ANNUAL_PERCENTAGE_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrAnnualPercentageRate(String installmentPaymentDataOptionItemNrAnnualPercentageRate) { @@ -154,6 +163,11 @@ public String getInstallmentPaymentDataOptionItemNrFirstInstallmentAmount() { } + /** + * First Installment Amount in minor units. + * + * @param installmentPaymentDataOptionItemNrFirstInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_FIRST_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrFirstInstallmentAmount(String installmentPaymentDataOptionItemNrFirstInstallmentAmount) { @@ -179,6 +193,11 @@ public String getInstallmentPaymentDataOptionItemNrInstallmentFee() { } + /** + * Installment fee amount in minor units. + * + * @param installmentPaymentDataOptionItemNrInstallmentFee + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_INSTALLMENT_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrInstallmentFee(String installmentPaymentDataOptionItemNrInstallmentFee) { @@ -204,6 +223,11 @@ public String getInstallmentPaymentDataOptionItemNrInterestRate() { } + /** + * Interest rate for the installment period. + * + * @param installmentPaymentDataOptionItemNrInterestRate + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_INTEREST_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrInterestRate(String installmentPaymentDataOptionItemNrInterestRate) { @@ -229,6 +253,11 @@ public String getInstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments() } + /** + * Maximum number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrMaximumNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_MAXIMUM_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments(String installmentPaymentDataOptionItemNrMaximumNumberOfInstallments) { @@ -254,6 +283,11 @@ public String getInstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments() } + /** + * Minimum number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrMinimumNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_MINIMUM_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments(String installmentPaymentDataOptionItemNrMinimumNumberOfInstallments) { @@ -279,6 +313,11 @@ public String getInstallmentPaymentDataOptionItemNrNumberOfInstallments() { } + /** + * Total number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrNumberOfInstallments(String installmentPaymentDataOptionItemNrNumberOfInstallments) { @@ -304,6 +343,11 @@ public String getInstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount() } + /** + * Subsequent Installment Amount in minor units. + * + * @param installmentPaymentDataOptionItemNrSubsequentInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_SUBSEQUENT_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount(String installmentPaymentDataOptionItemNrSubsequentInstallmentAmount) { @@ -329,6 +373,11 @@ public String getInstallmentPaymentDataOptionItemNrTotalAmountDue() { } + /** + * Total amount in minor units. + * + * @param installmentPaymentDataOptionItemNrTotalAmountDue + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_TOTAL_AMOUNT_DUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrTotalAmountDue(String installmentPaymentDataOptionItemNrTotalAmountDue) { @@ -354,6 +403,11 @@ public String getInstallmentPaymentDataPaymentOptions() { } + /** + * Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments + * + * @param installmentPaymentDataPaymentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_PAYMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataPaymentOptions(String installmentPaymentDataPaymentOptions) { @@ -379,6 +433,11 @@ public String getInstallmentsValue() { } + /** + * The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. + * + * @param installmentsValue + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentsValue(String installmentsValue) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataNetworkTokens.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataNetworkTokens.java index 8445d488f..0d8140443 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataNetworkTokens.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataNetworkTokens.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public String getNetworkTokenAvailable() { } + /** + * Indicates whether a network token is available for the specified card. + * + * @param networkTokenAvailable + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_AVAILABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenAvailable(String networkTokenAvailable) { @@ -93,6 +97,11 @@ public String getNetworkTokenBin() { } + /** + * The Bank Identification Number of a tokenized card, which is the first six digits of a card number. + * + * @param networkTokenBin + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenBin(String networkTokenBin) { @@ -118,6 +127,11 @@ public String getNetworkTokenTokenSummary() { } + /** + * The last four digits of a network token. + * + * @param networkTokenTokenSummary + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_TOKEN_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenTokenSummary(String networkTokenTokenSummary) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataOpi.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataOpi.java index 08e227ce6..ebb670b38 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataOpi.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataOpi.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -60,6 +59,11 @@ public String getOpiTransToken() { } + /** + * Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + * + * @param opiTransToken + */ @JsonProperty(JSON_PROPERTY_OPI_TRANS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpiTransToken(String opiTransToken) { diff --git a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataSepa.java b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataSepa.java index ad7b941b4..2c648a467 100644 --- a/src/main/java/com/adyen/model/payment/ResponseAdditionalDataSepa.java +++ b/src/main/java/com/adyen/model/payment/ResponseAdditionalDataSepa.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public String getSepadirectdebitDateOfSignature() { } + /** + * The transaction signature date. Format: yyyy-MM-dd + * + * @param sepadirectdebitDateOfSignature + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_DATE_OF_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitDateOfSignature(String sepadirectdebitDateOfSignature) { @@ -93,6 +97,11 @@ public String getSepadirectdebitMandateId() { } + /** + * Its value corresponds to the pspReference value of the transaction. + * + * @param sepadirectdebitMandateId + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_MANDATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitMandateId(String sepadirectdebitMandateId) { @@ -118,6 +127,11 @@ public String getSepadirectdebitSequenceType() { } + /** + * This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF + * + * @param sepadirectdebitSequenceType + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_SEQUENCE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitSequenceType(String sepadirectdebitSequenceType) { diff --git a/src/main/java/com/adyen/model/payment/SDKEphemPubKey.java b/src/main/java/com/adyen/model/payment/SDKEphemPubKey.java index 422c074b9..8385cd04f 100644 --- a/src/main/java/com/adyen/model/payment/SDKEphemPubKey.java +++ b/src/main/java/com/adyen/model/payment/SDKEphemPubKey.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -72,6 +71,11 @@ public String getCrv() { } + /** + * The `crv` value as received from the 3D Secure 2 SDK. + * + * @param crv + */ @JsonProperty(JSON_PROPERTY_CRV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCrv(String crv) { @@ -97,6 +101,11 @@ public String getKty() { } + /** + * The `kty` value as received from the 3D Secure 2 SDK. + * + * @param kty + */ @JsonProperty(JSON_PROPERTY_KTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setKty(String kty) { @@ -122,6 +131,11 @@ public String getX() { } + /** + * The `x` value as received from the 3D Secure 2 SDK. + * + * @param x + */ @JsonProperty(JSON_PROPERTY_X) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setX(String x) { @@ -147,6 +161,11 @@ public String getY() { } + /** + * The `y` value as received from the 3D Secure 2 SDK. + * + * @param y + */ @JsonProperty(JSON_PROPERTY_Y) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setY(String y) { diff --git a/src/main/java/com/adyen/model/payment/ServiceError.java b/src/main/java/com/adyen/model/payment/ServiceError.java index 9e981bccb..80fd725f1 100644 --- a/src/main/java/com/adyen/model/payment/ServiceError.java +++ b/src/main/java/com/adyen/model/payment/ServiceError.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -91,6 +90,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -116,6 +120,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -141,6 +150,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -166,6 +180,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -191,6 +210,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -216,6 +240,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/payment/ShopperInteractionDevice.java b/src/main/java/com/adyen/model/payment/ShopperInteractionDevice.java index ff6d66fb7..55000819f 100644 --- a/src/main/java/com/adyen/model/payment/ShopperInteractionDevice.java +++ b/src/main/java/com/adyen/model/payment/ShopperInteractionDevice.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -68,6 +67,11 @@ public String getLocale() { } + /** + * Locale on the shopper interaction device. + * + * @param locale + */ @JsonProperty(JSON_PROPERTY_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLocale(String locale) { @@ -93,6 +97,11 @@ public String getOs() { } + /** + * Operating system running on the shopper interaction device. + * + * @param os + */ @JsonProperty(JSON_PROPERTY_OS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOs(String os) { @@ -118,6 +127,11 @@ public String getOsVersion() { } + /** + * Version of the operating system on the shopper interaction device. + * + * @param osVersion + */ @JsonProperty(JSON_PROPERTY_OS_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOsVersion(String osVersion) { diff --git a/src/main/java/com/adyen/model/payment/Split.java b/src/main/java/com/adyen/model/payment/Split.java index 566fd03ba..589a112ba 100644 --- a/src/main/java/com/adyen/model/payment/Split.java +++ b/src/main/java/com/adyen/model/payment/Split.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -126,6 +125,11 @@ public String getAccount() { } + /** + * The unique identifier of the account to which the split amount is booked. Required if `type` is **MarketPlace** or **BalanceAccount**. * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): The [`accountCode`](https://docs.adyen.com/api-explorer/Account/latest/post/updateAccount#request-accountCode) of the account to which the split amount is booked. * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): The [`balanceAccountId`](https://docs.adyen.com/api-explorer/balanceplatform/latest/get/balanceAccounts/_id_#path-id) of the account to which the split amount is booked. + * + * @param account + */ @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccount(String account) { @@ -151,6 +155,11 @@ public SplitAmount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(SplitAmount amount) { @@ -176,6 +185,11 @@ public String getDescription() { } + /** + * Your description for the split item. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -201,6 +215,11 @@ public String getReference() { } + /** + * Your unique reference for the split item. This is required if `type` is **MarketPlace** ([Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic)) or **BalanceAccount** ([Balance Platform](https://docs.adyen.com/marketplaces-and-platforms)). For the other types, we also recommend providing a **unique** reference so you can reconcile the split and the associated payment in the transaction overview and in the reports. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -226,6 +245,11 @@ public TypeEnum getType() { } + /** + * The type of the split item. Possible values: * [Classic Platforms integration](https://docs.adyen.com/marketplaces-and-platforms/classic): **Commission**, **Default**, **Marketplace**, **PaymentFee**, **VAT**. * [Balance Platform](https://docs.adyen.com/marketplaces-and-platforms): **BalanceAccount**, **Commission**, **Default**, **PaymentFee**, **Remainder**, **Surcharge**, **Tip**, **VAT**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/payment/SplitAmount.java b/src/main/java/com/adyen/model/payment/SplitAmount.java index 881a7c8ae..de857af15 100644 --- a/src/main/java/com/adyen/model/payment/SplitAmount.java +++ b/src/main/java/com/adyen/model/payment/SplitAmount.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). By default, this is the original payment currency. + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -89,6 +93,11 @@ public Long getValue() { } + /** + * The value of the split amount, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/payment/SubMerchant.java b/src/main/java/com/adyen/model/payment/SubMerchant.java index d7ad72afc..80b751f98 100644 --- a/src/main/java/com/adyen/model/payment/SubMerchant.java +++ b/src/main/java/com/adyen/model/payment/SubMerchant.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -76,6 +75,11 @@ public String getCity() { } + /** + * The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -101,6 +105,11 @@ public String getCountry() { } + /** + * The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) * Fixed length: 3 characters + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -126,6 +135,11 @@ public String getMcc() { } + /** + * The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -151,6 +165,11 @@ public String getName() { } + /** + * The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear in the card statement. * Format: Alphanumeric * Maximum length: 22 characters + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -176,6 +195,11 @@ public String getTaxId() { } + /** + * The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/payment/TechnicalCancelRequest.java b/src/main/java/com/adyen/model/payment/TechnicalCancelRequest.java index a1a4621cf..cf3786055 100644 --- a/src/main/java/com/adyen/model/payment/TechnicalCancelRequest.java +++ b/src/main/java/com/adyen/model/payment/TechnicalCancelRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -112,6 +111,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -137,6 +141,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -162,6 +171,11 @@ public Amount getModificationAmount() { } + /** + * modificationAmount + * + * @param modificationAmount + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationAmount(Amount modificationAmount) { @@ -187,6 +201,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -212,6 +231,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -237,6 +261,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -262,6 +291,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -295,6 +329,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -320,6 +359,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -345,6 +389,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDS1Result.java b/src/main/java/com/adyen/model/payment/ThreeDS1Result.java index b233f3793..608ffea87 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDS1Result.java +++ b/src/main/java/com/adyen/model/payment/ThreeDS1Result.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -80,6 +79,11 @@ public String getCavv() { } + /** + * The cardholder authentication value (base64 encoded). + * + * @param cavv + */ @JsonProperty(JSON_PROPERTY_CAVV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavv(String cavv) { @@ -105,6 +109,11 @@ public String getCavvAlgorithm() { } + /** + * The CAVV algorithm used. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -130,6 +139,11 @@ public String getEci() { } + /** + * 3D Secure Electronic Commerce Indicator (ECI). + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -155,6 +169,11 @@ public String getThreeDAuthenticatedResponse() { } + /** + * The authentication response from the ACS. + * + * @param threeDAuthenticatedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticatedResponse(String threeDAuthenticatedResponse) { @@ -180,6 +199,11 @@ public String getThreeDOfferedResponse() { } + /** + * Whether 3D Secure was offered or not. + * + * @param threeDOfferedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOfferedResponse(String threeDOfferedResponse) { @@ -205,6 +229,11 @@ public String getXid() { } + /** + * A unique transaction identifier generated by the MPI on behalf of the merchant to identify the 3D Secure transaction, in `Base64` encoding. + * + * @param xid + */ @JsonProperty(JSON_PROPERTY_XID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setXid(String xid) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDS2RequestData.java b/src/main/java/com/adyen/model/payment/ThreeDS2RequestData.java index 5a9382452..d136d2c84 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDS2RequestData.java +++ b/src/main/java/com/adyen/model/payment/ThreeDS2RequestData.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -454,6 +453,11 @@ public AcctInfo getAcctInfo() { } + /** + * acctInfo + * + * @param acctInfo + */ @JsonProperty(JSON_PROPERTY_ACCT_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctInfo(AcctInfo acctInfo) { @@ -479,6 +483,11 @@ public AcctTypeEnum getAcctType() { } + /** + * Indicates the type of account. For example, for a multi-account card product. Length: 2 characters. Allowed values: * **01** — Not applicable * **02** — Credit * **03** — Debit + * + * @param acctType + */ @JsonProperty(JSON_PROPERTY_ACCT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcctType(AcctTypeEnum acctType) { @@ -504,6 +513,11 @@ public String getAcquirerBIN() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The acquiring BIN enrolled for 3D Secure 2. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. + * + * @param acquirerBIN + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_B_I_N) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerBIN(String acquirerBIN) { @@ -529,6 +543,11 @@ public String getAcquirerMerchantID() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchantId that is enrolled for 3D Secure 2 by the merchant's acquirer. This string should match the value that you will use in the authorisation. Use 123456 on the Test platform. + * + * @param acquirerMerchantID + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_MERCHANT_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerMerchantID(String acquirerMerchantID) { @@ -554,6 +573,11 @@ public AddrMatchEnum getAddrMatch() { } + /** + * Indicates whether the Cardholder Shipping Address and Cardholder Billing Address are the same. Allowed values: * **Y** — Shipping Address matches Billing Address. * **N** — Shipping Address does not match Billing Address. + * + * @param addrMatch + */ @JsonProperty(JSON_PROPERTY_ADDR_MATCH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddrMatch(AddrMatchEnum addrMatch) { @@ -581,6 +605,11 @@ public Boolean getAuthenticationOnly() { } + /** + * If set to true, you will only perform the [3D Secure 2 authentication](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only), and not the payment authorisation. + * + * @param authenticationOnly + */ @Deprecated @JsonProperty(JSON_PROPERTY_AUTHENTICATION_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -609,6 +638,11 @@ public ChallengeIndicatorEnum getChallengeIndicator() { } + /** + * Possibility to specify a preference for receiving a challenge from the issuer. Allowed values: * `noPreference` * `requestNoChallenge` * `requestChallenge` * `requestChallengeAsMandate` + * + * @param challengeIndicator + */ @Deprecated @JsonProperty(JSON_PROPERTY_CHALLENGE_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -635,6 +669,11 @@ public String getDeviceChannel() { } + /** + * The environment of the shopper. Allowed values: * `app` * `browser` + * + * @param deviceChannel + */ @JsonProperty(JSON_PROPERTY_DEVICE_CHANNEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceChannel(String deviceChannel) { @@ -660,6 +699,11 @@ public DeviceRenderOptions getDeviceRenderOptions() { } + /** + * deviceRenderOptions + * + * @param deviceRenderOptions + */ @JsonProperty(JSON_PROPERTY_DEVICE_RENDER_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceRenderOptions(DeviceRenderOptions deviceRenderOptions) { @@ -685,6 +729,11 @@ public Phone getHomePhone() { } + /** + * homePhone + * + * @param homePhone + */ @JsonProperty(JSON_PROPERTY_HOME_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHomePhone(Phone homePhone) { @@ -710,6 +759,11 @@ public String getMcc() { } + /** + * Required for merchants that have been enrolled for 3D Secure 2 by another party than Adyen, mostly [authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The `mcc` is a four-digit code with which the previously given `acquirerMerchantID` is registered at the scheme. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -735,6 +789,11 @@ public String getMerchantName() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). The merchant name that the issuer presents to the shopper if they get a challenge. We recommend to use the same value that you will use in the authorization. Maximum length is 40 characters. > Optional for a [full 3D Secure 2 integration](https://docs.adyen.com/online-payments/3d-secure/native-3ds2/api-integration). Use this field if you are enrolled for 3D Secure 2 with us and want to override the merchant name already configured on your account. + * + * @param merchantName + */ @JsonProperty(JSON_PROPERTY_MERCHANT_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantName(String merchantName) { @@ -760,6 +819,11 @@ public String getMessageVersion() { } + /** + * The `messageVersion` value indicating the 3D Secure 2 protocol version. + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -785,6 +849,11 @@ public Phone getMobilePhone() { } + /** + * mobilePhone + * + * @param mobilePhone + */ @JsonProperty(JSON_PROPERTY_MOBILE_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMobilePhone(Phone mobilePhone) { @@ -810,6 +879,11 @@ public String getNotificationURL() { } + /** + * URL to where the issuer should send the `CRes`. Required if you are not using components for `channel` **Web** or if you are using classic integration `deviceChannel` **browser**. + * + * @param notificationURL + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationURL(String notificationURL) { @@ -835,6 +909,11 @@ public Boolean getPayTokenInd() { } + /** + * Value **true** indicates that the transaction was de-tokenised prior to being received by the ACS. + * + * @param payTokenInd + */ @JsonProperty(JSON_PROPERTY_PAY_TOKEN_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayTokenInd(Boolean payTokenInd) { @@ -860,6 +939,11 @@ public String getPaymentAuthenticationUseCase() { } + /** + * Indicates the type of payment for which an authentication is requested (message extension) + * + * @param paymentAuthenticationUseCase + */ @JsonProperty(JSON_PROPERTY_PAYMENT_AUTHENTICATION_USE_CASE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAuthenticationUseCase(String paymentAuthenticationUseCase) { @@ -885,6 +969,11 @@ public String getPurchaseInstalData() { } + /** + * Indicates the maximum number of authorisations permitted for instalment payments. Length: 1–3 characters. + * + * @param purchaseInstalData + */ @JsonProperty(JSON_PROPERTY_PURCHASE_INSTAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPurchaseInstalData(String purchaseInstalData) { @@ -910,6 +999,11 @@ public String getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Format: YYYYMMDD + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(String recurringExpiry) { @@ -935,6 +1029,11 @@ public String getRecurringFrequency() { } + /** + * Indicates the minimum number of days between authorisations. Maximum length: 4 characters. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -960,6 +1059,11 @@ public String getSdkAppID() { } + /** + * The `sdkAppID` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. + * + * @param sdkAppID + */ @JsonProperty(JSON_PROPERTY_SDK_APP_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkAppID(String sdkAppID) { @@ -985,6 +1089,11 @@ public String getSdkEncData() { } + /** + * The `sdkEncData` value as received from the 3D Secure 2 SDK. Required for `deviceChannel` set to **app**. + * + * @param sdkEncData + */ @JsonProperty(JSON_PROPERTY_SDK_ENC_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkEncData(String sdkEncData) { @@ -1010,6 +1119,11 @@ public SDKEphemPubKey getSdkEphemPubKey() { } + /** + * sdkEphemPubKey + * + * @param sdkEphemPubKey + */ @JsonProperty(JSON_PROPERTY_SDK_EPHEM_PUB_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkEphemPubKey(SDKEphemPubKey sdkEphemPubKey) { @@ -1035,6 +1149,11 @@ public Integer getSdkMaxTimeout() { } + /** + * The maximum amount of time in minutes for the 3D Secure 2 authentication process. Optional and only for `deviceChannel` set to **app**. Defaults to **60** minutes. + * + * @param sdkMaxTimeout + */ @JsonProperty(JSON_PROPERTY_SDK_MAX_TIMEOUT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkMaxTimeout(Integer sdkMaxTimeout) { @@ -1060,6 +1179,11 @@ public String getSdkReferenceNumber() { } + /** + * The `sdkReferenceNumber` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. + * + * @param sdkReferenceNumber + */ @JsonProperty(JSON_PROPERTY_SDK_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkReferenceNumber(String sdkReferenceNumber) { @@ -1085,6 +1209,11 @@ public String getSdkTransID() { } + /** + * The `sdkTransID` value as received from the 3D Secure 2 SDK. Only for `deviceChannel` set to **app**. + * + * @param sdkTransID + */ @JsonProperty(JSON_PROPERTY_SDK_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkTransID(String sdkTransID) { @@ -1110,6 +1239,11 @@ public String getSdkVersion() { } + /** + * Version of the 3D Secure 2 mobile SDK. Only for `deviceChannel` set to **app**. + * + * @param sdkVersion + */ @JsonProperty(JSON_PROPERTY_SDK_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSdkVersion(String sdkVersion) { @@ -1135,6 +1269,11 @@ public String getThreeDSCompInd() { } + /** + * Completion indicator for the device fingerprinting. + * + * @param threeDSCompInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_COMP_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSCompInd(String threeDSCompInd) { @@ -1160,6 +1299,11 @@ public String getThreeDSRequestorAuthenticationInd() { } + /** + * Indicates the type of Authentication request. + * + * @param threeDSRequestorAuthenticationInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_AUTHENTICATION_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorAuthenticationInd(String threeDSRequestorAuthenticationInd) { @@ -1185,6 +1329,11 @@ public ThreeDSRequestorAuthenticationInfo getThreeDSRequestorAuthenticationInfo( } + /** + * threeDSRequestorAuthenticationInfo + * + * @param threeDSRequestorAuthenticationInfo + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_AUTHENTICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorAuthenticationInfo(ThreeDSRequestorAuthenticationInfo threeDSRequestorAuthenticationInfo) { @@ -1210,6 +1359,11 @@ public ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd() { } + /** + * Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only + * + * @param threeDSRequestorChallengeInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorChallengeInd(ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd) { @@ -1235,6 +1389,11 @@ public String getThreeDSRequestorID() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor identifier assigned by the Directory Server when you enrol for 3D Secure 2. + * + * @param threeDSRequestorID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorID(String threeDSRequestorID) { @@ -1260,6 +1419,11 @@ public String getThreeDSRequestorName() { } + /** + * Required for [authentication-only integration](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only) for Visa. Unique 3D Secure requestor name assigned by the Directory Server when you enrol for 3D Secure 2. + * + * @param threeDSRequestorName + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorName(String threeDSRequestorName) { @@ -1285,6 +1449,11 @@ public ThreeDSRequestorPriorAuthenticationInfo getThreeDSRequestorPriorAuthentic } + /** + * threeDSRequestorPriorAuthenticationInfo + * + * @param threeDSRequestorPriorAuthenticationInfo + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_PRIOR_AUTHENTICATION_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorPriorAuthenticationInfo(ThreeDSRequestorPriorAuthenticationInfo threeDSRequestorPriorAuthenticationInfo) { @@ -1310,6 +1479,11 @@ public String getThreeDSRequestorURL() { } + /** + * URL of the (customer service) website that will be shown to the shopper in case of technical errors during the 3D Secure 2 process. + * + * @param threeDSRequestorURL + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_U_R_L) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorURL(String threeDSRequestorURL) { @@ -1335,6 +1509,11 @@ public TransTypeEnum getTransType() { } + /** + * Identifies the type of transaction being authenticated. Length: 2 characters. Allowed values: * **01** — Goods/Service Purchase * **03** — Check Acceptance * **10** — Account Funding * **11** — Quasi-Cash Transaction * **28** — Prepaid Activation and Load + * + * @param transType + */ @JsonProperty(JSON_PROPERTY_TRANS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransType(TransTypeEnum transType) { @@ -1360,6 +1539,11 @@ public TransactionTypeEnum getTransactionType() { } + /** + * Identify the type of the transaction being authenticated. + * + * @param transactionType + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionType(TransactionTypeEnum transactionType) { @@ -1385,6 +1569,11 @@ public String getWhiteListStatus() { } + /** + * The `whiteListStatus` value returned from a previous 3D Secure 2 transaction, only applicable for 3D Secure 2 protocol version 2.2.0. + * + * @param whiteListStatus + */ @JsonProperty(JSON_PROPERTY_WHITE_LIST_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWhiteListStatus(String whiteListStatus) { @@ -1410,6 +1599,11 @@ public Phone getWorkPhone() { } + /** + * workPhone + * + * @param workPhone + */ @JsonProperty(JSON_PROPERTY_WORK_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWorkPhone(Phone workPhone) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDS2Result.java b/src/main/java/com/adyen/model/payment/ThreeDS2Result.java index 79921f7c9..650a38db2 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDS2Result.java +++ b/src/main/java/com/adyen/model/payment/ThreeDS2Result.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -239,6 +238,11 @@ public String getAuthenticationValue() { } + /** + * The `authenticationValue` value as defined in the 3D Secure 2 specification. + * + * @param authenticationValue + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationValue(String authenticationValue) { @@ -264,6 +268,11 @@ public String getCavvAlgorithm() { } + /** + * The algorithm used by the ACS to calculate the authentication value, only for Cartes Bancaires integrations. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -289,6 +298,11 @@ public ChallengeCancelEnum getChallengeCancel() { } + /** + * 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). + * + * @param challengeCancel + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_CANCEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeCancel(ChallengeCancelEnum challengeCancel) { @@ -314,6 +328,11 @@ public String getDsTransID() { } + /** + * The `dsTransID` value as defined in the 3D Secure 2 specification. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -339,6 +358,11 @@ public String getEci() { } + /** + * The `eci` value as defined in the 3D Secure 2 specification. + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -364,6 +388,11 @@ public ExemptionIndicatorEnum getExemptionIndicator() { } + /** + * Indicates the exemption type that was applied by the issuer to the authentication, if exemption applied. Allowed values: * `lowValue` * `secureCorporate` * `trustedBeneficiary` * `transactionRiskAnalysis` + * + * @param exemptionIndicator + */ @JsonProperty(JSON_PROPERTY_EXEMPTION_INDICATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExemptionIndicator(ExemptionIndicatorEnum exemptionIndicator) { @@ -389,6 +418,11 @@ public String getMessageVersion() { } + /** + * The `messageVersion` value as defined in the 3D Secure 2 specification. + * + * @param messageVersion + */ @JsonProperty(JSON_PROPERTY_MESSAGE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessageVersion(String messageVersion) { @@ -414,6 +448,11 @@ public String getRiskScore() { } + /** + * Risk score calculated by Cartes Bancaires Directory Server (DS). + * + * @param riskScore + */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskScore(String riskScore) { @@ -439,6 +478,11 @@ public ThreeDSRequestorChallengeIndEnum getThreeDSRequestorChallengeInd() { } + /** + * Indicates whether a challenge is requested for this transaction. Possible values: * **01** — No preference * **02** — No challenge requested * **03** — Challenge requested (3DS Requestor preference) * **04** — Challenge requested (Mandate) * **05** — No challenge (transactional risk analysis is already performed) * **06** — Data Only + * + * @param threeDSRequestorChallengeInd + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQUESTOR_CHALLENGE_IND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSRequestorChallengeInd(ThreeDSRequestorChallengeIndEnum threeDSRequestorChallengeInd) { @@ -464,6 +508,11 @@ public String getThreeDSServerTransID() { } + /** + * The `threeDSServerTransID` value as defined in the 3D Secure 2 specification. + * + * @param threeDSServerTransID + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_SERVER_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSServerTransID(String threeDSServerTransID) { @@ -489,6 +538,11 @@ public String getTimestamp() { } + /** + * The `timestamp` value of the 3D Secure 2 authentication. + * + * @param timestamp + */ @JsonProperty(JSON_PROPERTY_TIMESTAMP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTimestamp(String timestamp) { @@ -514,6 +568,11 @@ public String getTransStatus() { } + /** + * The `transStatus` value as defined in the 3D Secure 2 specification. + * + * @param transStatus + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatus(String transStatus) { @@ -539,6 +598,11 @@ public String getTransStatusReason() { } + /** + * 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). + * + * @param transStatusReason + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatusReason(String transStatusReason) { @@ -564,6 +628,11 @@ public String getWhiteListStatus() { } + /** + * The `whiteListStatus` value as defined in the 3D Secure 2 specification. + * + * @param whiteListStatus + */ @JsonProperty(JSON_PROPERTY_WHITE_LIST_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWhiteListStatus(String whiteListStatus) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDS2ResultRequest.java b/src/main/java/com/adyen/model/payment/ThreeDS2ResultRequest.java index 5907e16e4..5a2270aa8 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDS2ResultRequest.java +++ b/src/main/java/com/adyen/model/payment/ThreeDS2ResultRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -89,6 +93,11 @@ public String getPspReference() { } + /** + * The pspReference returned in the /authorise call. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDS2ResultResponse.java b/src/main/java/com/adyen/model/payment/ThreeDS2ResultResponse.java index ac29dc377..ae6072aef 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDS2ResultResponse.java +++ b/src/main/java/com/adyen/model/payment/ThreeDS2ResultResponse.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -61,6 +60,11 @@ public ThreeDS2Result getThreeDS2Result() { } + /** + * threeDS2Result + * + * @param threeDS2Result + */ @JsonProperty(JSON_PROPERTY_THREE_D_S2_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDS2Result(ThreeDS2Result threeDS2Result) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDSRequestorAuthenticationInfo.java b/src/main/java/com/adyen/model/payment/ThreeDSRequestorAuthenticationInfo.java index 51419f0f8..255922af6 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDSRequestorAuthenticationInfo.java +++ b/src/main/java/com/adyen/model/payment/ThreeDSRequestorAuthenticationInfo.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -111,6 +110,11 @@ public String getThreeDSReqAuthData() { } + /** + * Data that documents and supports a specific authentication process. Maximum length: 2048 bytes. + * + * @param threeDSReqAuthData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_AUTH_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqAuthData(String threeDSReqAuthData) { @@ -136,6 +140,11 @@ public ThreeDSReqAuthMethodEnum getThreeDSReqAuthMethod() { } + /** + * Mechanism used by the Cardholder to authenticate to the 3DS Requestor. Allowed values: * **01** — No 3DS Requestor authentication occurred (for example, cardholder “logged in” as guest). * **02** — Login to the cardholder account at the 3DS Requestor system using 3DS Requestor’s own credentials. * **03** — Login to the cardholder account at the 3DS Requestor system using federated ID. * **04** — Login to the cardholder account at the 3DS Requestor system using issuer credentials. * **05** — Login to the cardholder account at the 3DS Requestor system using third-party authentication. * **06** — Login to the cardholder account at the 3DS Requestor system using FIDO Authenticator. + * + * @param threeDSReqAuthMethod + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_AUTH_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqAuthMethod(ThreeDSReqAuthMethodEnum threeDSReqAuthMethod) { @@ -161,6 +170,11 @@ public String getThreeDSReqAuthTimestamp() { } + /** + * Date and time in UTC of the cardholder authentication. Format: YYYYMMDDHHMM + * + * @param threeDSReqAuthTimestamp + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_AUTH_TIMESTAMP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqAuthTimestamp(String threeDSReqAuthTimestamp) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDSRequestorPriorAuthenticationInfo.java b/src/main/java/com/adyen/model/payment/ThreeDSRequestorPriorAuthenticationInfo.java index 6e1ca4f78..553993458 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDSRequestorPriorAuthenticationInfo.java +++ b/src/main/java/com/adyen/model/payment/ThreeDSRequestorPriorAuthenticationInfo.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -111,6 +110,11 @@ public String getThreeDSReqPriorAuthData() { } + /** + * Data that documents and supports a specific authentication process. Maximum length: 2048 bytes. + * + * @param threeDSReqPriorAuthData + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_AUTH_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorAuthData(String threeDSReqPriorAuthData) { @@ -136,6 +140,11 @@ public ThreeDSReqPriorAuthMethodEnum getThreeDSReqPriorAuthMethod() { } + /** + * Mechanism used by the Cardholder to previously authenticate to the 3DS Requestor. Allowed values: * **01** — Frictionless authentication occurred by ACS. * **02** — Cardholder challenge occurred by ACS. * **03** — AVS verified. * **04** — Other issuer methods. + * + * @param threeDSReqPriorAuthMethod + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_AUTH_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorAuthMethod(ThreeDSReqPriorAuthMethodEnum threeDSReqPriorAuthMethod) { @@ -161,6 +170,11 @@ public String getThreeDSReqPriorAuthTimestamp() { } + /** + * Date and time in UTC of the prior cardholder authentication. Format: YYYYMMDDHHMM + * + * @param threeDSReqPriorAuthTimestamp + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_AUTH_TIMESTAMP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorAuthTimestamp(String threeDSReqPriorAuthTimestamp) { @@ -186,6 +200,11 @@ public String getThreeDSReqPriorRef() { } + /** + * This data element provides additional information to the ACS to determine the best approach for handing a request. This data element contains an ACS Transaction ID for a prior authenticated transaction. For example, the first recurring transaction that was authenticated with the cardholder. Length: 30 characters. + * + * @param threeDSReqPriorRef + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_REQ_PRIOR_REF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSReqPriorRef(String threeDSReqPriorRef) { diff --git a/src/main/java/com/adyen/model/payment/ThreeDSecureData.java b/src/main/java/com/adyen/model/payment/ThreeDSecureData.java index 77eefedc4..5566e6bf8 100644 --- a/src/main/java/com/adyen/model/payment/ThreeDSecureData.java +++ b/src/main/java/com/adyen/model/payment/ThreeDSecureData.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -235,6 +234,11 @@ public AuthenticationResponseEnum getAuthenticationResponse() { } + /** + * In 3D Secure 1, the authentication response if the shopper was redirected. In 3D Secure 2, this is the `transStatus` from the challenge result. If the transaction was frictionless, omit this parameter. + * + * @param authenticationResponse + */ @JsonProperty(JSON_PROPERTY_AUTHENTICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthenticationResponse(AuthenticationResponseEnum authenticationResponse) { @@ -260,6 +264,11 @@ public byte[] getCavv() { } + /** + * The cardholder authentication value (base64 encoded, 20 bytes in a decoded form). + * + * @param cavv + */ @JsonProperty(JSON_PROPERTY_CAVV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavv(byte[] cavv) { @@ -285,6 +294,11 @@ public String getCavvAlgorithm() { } + /** + * The CAVV algorithm used. Include this only for 3D Secure 1. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -310,6 +324,11 @@ public ChallengeCancelEnum getChallengeCancel() { } + /** + * 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). + * + * @param challengeCancel + */ @JsonProperty(JSON_PROPERTY_CHALLENGE_CANCEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setChallengeCancel(ChallengeCancelEnum challengeCancel) { @@ -335,6 +354,11 @@ public DirectoryResponseEnum getDirectoryResponse() { } + /** + * In 3D Secure 1, this is the enrollment response from the 3D directory server. In 3D Secure 2, this is the `transStatus` from the `ARes`. + * + * @param directoryResponse + */ @JsonProperty(JSON_PROPERTY_DIRECTORY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirectoryResponse(DirectoryResponseEnum directoryResponse) { @@ -360,6 +384,11 @@ public String getDsTransID() { } + /** + * Supported for 3D Secure 2. The unique transaction identifier assigned by the Directory Server (DS) to identify a single transaction. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -385,6 +414,11 @@ public String getEci() { } + /** + * The electronic commerce indicator. + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -410,6 +444,11 @@ public String getRiskScore() { } + /** + * Risk score calculated by Directory Server (DS). Required for Cartes Bancaires integrations. + * + * @param riskScore + */ @JsonProperty(JSON_PROPERTY_RISK_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRiskScore(String riskScore) { @@ -435,6 +474,11 @@ public String getThreeDSVersion() { } + /** + * The version of the 3D Secure protocol. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { @@ -460,6 +504,11 @@ public byte[] getTokenAuthenticationVerificationValue() { } + /** + * Network token authentication verification value (TAVV). The network token cryptogram. + * + * @param tokenAuthenticationVerificationValue + */ @JsonProperty(JSON_PROPERTY_TOKEN_AUTHENTICATION_VERIFICATION_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenAuthenticationVerificationValue(byte[] tokenAuthenticationVerificationValue) { @@ -485,6 +534,11 @@ public String getTransStatusReason() { } + /** + * 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). + * + * @param transStatusReason + */ @JsonProperty(JSON_PROPERTY_TRANS_STATUS_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransStatusReason(String transStatusReason) { @@ -510,6 +564,11 @@ public byte[] getXid() { } + /** + * Supported for 3D Secure 1. The transaction identifier (Base64-encoded, 20 bytes in a decoded form). + * + * @param xid + */ @JsonProperty(JSON_PROPERTY_XID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setXid(byte[] xid) { diff --git a/src/main/java/com/adyen/model/payment/VoidPendingRefundRequest.java b/src/main/java/com/adyen/model/payment/VoidPendingRefundRequest.java index b071f716e..a09ef6c3e 100644 --- a/src/main/java/com/adyen/model/payment/VoidPendingRefundRequest.java +++ b/src/main/java/com/adyen/model/payment/VoidPendingRefundRequest.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -116,6 +115,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular modification request. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -141,6 +145,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that is used to process the payment. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -166,6 +175,11 @@ public Amount getModificationAmount() { } + /** + * modificationAmount + * + * @param modificationAmount + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationAmount(Amount modificationAmount) { @@ -191,6 +205,11 @@ public ThreeDSecureData getMpiData() { } + /** + * mpiData + * + * @param mpiData + */ @JsonProperty(JSON_PROPERTY_MPI_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMpiData(ThreeDSecureData mpiData) { @@ -216,6 +235,11 @@ public String getOriginalMerchantReference() { } + /** + * The original merchant reference to cancel. + * + * @param originalMerchantReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalMerchantReference(String originalMerchantReference) { @@ -241,6 +265,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. This reference is returned in: * authorisation response * authorisation notification + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -266,6 +295,11 @@ public PlatformChargebackLogic getPlatformChargebackLogic() { } + /** + * platformChargebackLogic + * + * @param platformChargebackLogic + */ @JsonProperty(JSON_PROPERTY_PLATFORM_CHARGEBACK_LOGIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformChargebackLogic(PlatformChargebackLogic platformChargebackLogic) { @@ -291,6 +325,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -324,6 +363,11 @@ public List getSplits() { } + /** + * An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + * + * @param splits + */ @JsonProperty(JSON_PROPERTY_SPLITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSplits(List splits) { @@ -349,6 +393,11 @@ public String getTenderReference() { } + /** + * The transaction reference provided by the PED. For point-of-sale integrations only. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -374,6 +423,11 @@ public String getUniqueTerminalId() { } + /** + * Unique terminal ID for the PED that originally processed the request. For point-of-sale integrations only. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/payout/Address.java b/src/main/java/com/adyen/model/payout/Address.java index 4a1fa8d27..dcc2ec7e6 100644 --- a/src/main/java/com/adyen/model/payout/Address.java +++ b/src/main/java/com/adyen/model/payout/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -154,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -179,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -204,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/payout/Amount.java b/src/main/java/com/adyen/model/payout/Amount.java index 390f39420..49c5e7caa 100644 --- a/src/main/java/com/adyen/model/payout/Amount.java +++ b/src/main/java/com/adyen/model/payout/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/payout/BankAccount.java b/src/main/java/com/adyen/model/payout/BankAccount.java index c7e4d0b37..ddb1093ad 100644 --- a/src/main/java/com/adyen/model/payout/BankAccount.java +++ b/src/main/java/com/adyen/model/payout/BankAccount.java @@ -91,6 +91,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -116,6 +121,11 @@ public String getBankCity() { } + /** + * The bank city. + * + * @param bankCity + */ @JsonProperty(JSON_PROPERTY_BANK_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCity(String bankCity) { @@ -141,6 +151,11 @@ public String getBankLocationId() { } + /** + * The location id of the bank. The field value is `nil` in most cases. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -166,6 +181,11 @@ public String getBankName() { } + /** + * The name of the bank. + * + * @param bankName + */ @JsonProperty(JSON_PROPERTY_BANK_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankName(String bankName) { @@ -191,6 +211,11 @@ public String getBic() { } + /** + * The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -216,6 +241,11 @@ public String getCountryCode() { } + /** + * Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL'). + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -241,6 +271,11 @@ public String getIban() { } + /** + * The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -266,6 +301,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -291,6 +331,11 @@ public String getTaxId() { } + /** + * The bank account holder's tax ID. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/payout/Card.java b/src/main/java/com/adyen/model/payout/Card.java index 4bac45429..7995bc4bf 100644 --- a/src/main/java/com/adyen/model/payout/Card.java +++ b/src/main/java/com/adyen/model/payout/Card.java @@ -87,6 +87,11 @@ public String getCvc() { } + /** + * The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 – length: 3 digits * CID – length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -112,6 +117,11 @@ public String getExpiryMonth() { } + /** + * The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -137,6 +147,11 @@ public String getExpiryYear() { } + /** + * The card expiry year. Format: 4 digits. For example: 2020 + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -162,6 +177,11 @@ public String getHolderName() { } + /** + * The name of the cardholder, as printed on the card. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -187,6 +207,11 @@ public String getIssueNumber() { } + /** + * The issue number of the card (for some UK debit cards only). + * + * @param issueNumber + */ @JsonProperty(JSON_PROPERTY_ISSUE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssueNumber(String issueNumber) { @@ -212,6 +237,11 @@ public String getNumber() { } + /** + * The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -237,6 +267,11 @@ public String getStartMonth() { } + /** + * The month component of the start date (for some UK debit cards only). + * + * @param startMonth + */ @JsonProperty(JSON_PROPERTY_START_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartMonth(String startMonth) { @@ -262,6 +297,11 @@ public String getStartYear() { } + /** + * The year component of the start date (for some UK debit cards only). + * + * @param startYear + */ @JsonProperty(JSON_PROPERTY_START_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartYear(String startYear) { diff --git a/src/main/java/com/adyen/model/payout/FraudCheckResult.java b/src/main/java/com/adyen/model/payout/FraudCheckResult.java index 47ffb0181..22be5e784 100644 --- a/src/main/java/com/adyen/model/payout/FraudCheckResult.java +++ b/src/main/java/com/adyen/model/payout/FraudCheckResult.java @@ -67,6 +67,11 @@ public Integer getAccountScore() { } + /** + * The fraud score generated by the risk check. + * + * @param accountScore + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountScore(Integer accountScore) { @@ -92,6 +97,11 @@ public Integer getCheckId() { } + /** + * The ID of the risk check. + * + * @param checkId + */ @JsonProperty(JSON_PROPERTY_CHECK_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCheckId(Integer checkId) { @@ -117,6 +127,11 @@ public String getName() { } + /** + * The name of the risk check. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { diff --git a/src/main/java/com/adyen/model/payout/FraudCheckResultWrapper.java b/src/main/java/com/adyen/model/payout/FraudCheckResultWrapper.java index da532dc7e..49588b8b4 100644 --- a/src/main/java/com/adyen/model/payout/FraudCheckResultWrapper.java +++ b/src/main/java/com/adyen/model/payout/FraudCheckResultWrapper.java @@ -60,6 +60,11 @@ public FraudCheckResult getFraudCheckResult() { } + /** + * fraudCheckResult + * + * @param fraudCheckResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_CHECK_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudCheckResult(FraudCheckResult fraudCheckResult) { diff --git a/src/main/java/com/adyen/model/payout/FraudResult.java b/src/main/java/com/adyen/model/payout/FraudResult.java index 93d9cd642..c1794650b 100644 --- a/src/main/java/com/adyen/model/payout/FraudResult.java +++ b/src/main/java/com/adyen/model/payout/FraudResult.java @@ -66,6 +66,11 @@ public Integer getAccountScore() { } + /** + * The total fraud score generated by the risk checks. + * + * @param accountScore + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountScore(Integer accountScore) { @@ -99,6 +104,11 @@ public List getResults() { } + /** + * The result of the individual risk checks. + * + * @param results + */ @JsonProperty(JSON_PROPERTY_RESULTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResults(List results) { diff --git a/src/main/java/com/adyen/model/payout/FundSource.java b/src/main/java/com/adyen/model/payout/FundSource.java index 0e1961f34..0cfc4cf77 100644 --- a/src/main/java/com/adyen/model/payout/FundSource.java +++ b/src/main/java/com/adyen/model/payout/FundSource.java @@ -93,6 +93,11 @@ public Map getAdditionalData() { } + /** + * A map of name-value pairs for passing additional or industry-specific data. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -118,6 +123,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -143,6 +153,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -168,6 +183,11 @@ public String getShopperEmail() { } + /** + * Email address of the person. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -193,6 +213,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -218,6 +243,11 @@ public String getTelephoneNumber() { } + /** + * Phone number of the person + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { diff --git a/src/main/java/com/adyen/model/payout/ModifyRequest.java b/src/main/java/com/adyen/model/payout/ModifyRequest.java index 3a900a2df..2e9bf565c 100644 --- a/src/main/java/com/adyen/model/payout/ModifyRequest.java +++ b/src/main/java/com/adyen/model/payout/ModifyRequest.java @@ -78,6 +78,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular payout request. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -103,6 +108,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -128,6 +138,11 @@ public String getOriginalReference() { } + /** + * The PSP reference received in the `/submitThirdParty` response. + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { diff --git a/src/main/java/com/adyen/model/payout/ModifyResponse.java b/src/main/java/com/adyen/model/payout/ModifyResponse.java index 4e51fcaf7..ffb9f6bc8 100644 --- a/src/main/java/com/adyen/model/payout/ModifyResponse.java +++ b/src/main/java/com/adyen/model/payout/ModifyResponse.java @@ -78,6 +78,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be returned in a particular response. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -103,6 +108,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction. This value is globally unique; quote it when communicating with us about this response. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -128,6 +138,11 @@ public String getResponse() { } + /** + * The response: * In case of success, it is either `payout-confirm-received` or `payout-decline-received`. * In case of an error, an informational message is returned. + * + * @param response + */ @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponse(String response) { diff --git a/src/main/java/com/adyen/model/payout/Name.java b/src/main/java/com/adyen/model/payout/Name.java index 4bd86b5f3..5c076ecbe 100644 --- a/src/main/java/com/adyen/model/payout/Name.java +++ b/src/main/java/com/adyen/model/payout/Name.java @@ -63,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -88,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/payout/PayoutRequest.java b/src/main/java/com/adyen/model/payout/PayoutRequest.java index 1dbdcf070..5c32a506d 100644 --- a/src/main/java/com/adyen/model/payout/PayoutRequest.java +++ b/src/main/java/com/adyen/model/payout/PayoutRequest.java @@ -156,6 +156,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -181,6 +186,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -206,6 +216,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -231,6 +246,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -256,6 +276,11 @@ public FundSource getFundSource() { } + /** + * fundSource + * + * @param fundSource + */ @JsonProperty(JSON_PROPERTY_FUND_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundSource(FundSource fundSource) { @@ -281,6 +306,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -306,6 +336,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -331,6 +366,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -356,6 +396,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -381,6 +426,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. We recommend that you provide this data, as it is used in velocity fraud checks. > For 3D Secure 2 transactions, schemes require `shopperEmail` for all browser-based and mobile implementations. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -406,6 +456,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -431,6 +486,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -456,6 +516,11 @@ public String getShopperReference() { } + /** + * Required for recurring payments. Your reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters. > Your reference must not include personally identifiable information (PII), for example name or email address. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -481,6 +546,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's telephone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { diff --git a/src/main/java/com/adyen/model/payout/PayoutResponse.java b/src/main/java/com/adyen/model/payout/PayoutResponse.java index 4928226b7..6c37c358e 100644 --- a/src/main/java/com/adyen/model/payout/PayoutResponse.java +++ b/src/main/java/com/adyen/model/payout/PayoutResponse.java @@ -171,6 +171,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -196,6 +201,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -221,6 +231,11 @@ public Amount getDccAmount() { } + /** + * dccAmount + * + * @param dccAmount + */ @JsonProperty(JSON_PROPERTY_DCC_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccAmount(Amount dccAmount) { @@ -246,6 +261,11 @@ public String getDccSignature() { } + /** + * Cryptographic signature used to verify `dccQuote`. > This value only applies if you have implemented Dynamic Currency Conversion. For more information, [contact Support](https://www.adyen.help/hc/en-us/requests/new). + * + * @param dccSignature + */ @JsonProperty(JSON_PROPERTY_DCC_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDccSignature(String dccSignature) { @@ -271,6 +291,11 @@ public FraudResult getFraudResult() { } + /** + * fraudResult + * + * @param fraudResult + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResult(FraudResult fraudResult) { @@ -296,6 +321,11 @@ public String getIssuerUrl() { } + /** + * The URL to direct the shopper to. > In case of SecurePlus, do not redirect a shopper to this URL. + * + * @param issuerUrl + */ @JsonProperty(JSON_PROPERTY_ISSUER_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerUrl(String issuerUrl) { @@ -321,6 +351,11 @@ public String getMd() { } + /** + * The payment session. + * + * @param md + */ @JsonProperty(JSON_PROPERTY_MD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMd(String md) { @@ -346,6 +381,11 @@ public String getPaRequest() { } + /** + * The 3D request data for the issuer. If the value is **CUPSecurePlus-CollectSMSVerificationCode**, collect an SMS code from the shopper and pass it in the `/authorise3D` request. For more information, see [3D Secure](https://docs.adyen.com/classic-integration/3d-secure). + * + * @param paRequest + */ @JsonProperty(JSON_PROPERTY_PA_REQUEST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaRequest(String paRequest) { @@ -371,6 +411,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -396,6 +441,11 @@ public String getRefusalReason() { } + /** + * If the payment's authorisation is refused or an error occurs during authorisation, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. For more information, see [Refusal reasons](https://docs.adyen.com/development-resources/refusal-reasons). + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -421,6 +471,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes). Possible values: * **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions. * **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only). * **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state. * **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state. * **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state. * **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions. * **PartiallyAuthorised** – The payment has been authorised for a partial amount. This happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds. * **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment. * **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment. * **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments. * **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation. * **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { diff --git a/src/main/java/com/adyen/model/payout/Recurring.java b/src/main/java/com/adyen/model/payout/Recurring.java index 61a7db561..97eeab15c 100644 --- a/src/main/java/com/adyen/model/payout/Recurring.java +++ b/src/main/java/com/adyen/model/payout/Recurring.java @@ -152,6 +152,11 @@ public ContractEnum getContract() { } + /** + * The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts). + * + * @param contract + */ @JsonProperty(JSON_PROPERTY_CONTRACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContract(ContractEnum contract) { @@ -177,6 +182,11 @@ public String getRecurringDetailName() { } + /** + * A descriptive name for this detail. + * + * @param recurringDetailName + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailName(String recurringDetailName) { @@ -202,6 +212,11 @@ public OffsetDateTime getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(OffsetDateTime recurringExpiry) { @@ -227,6 +242,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -252,6 +272,11 @@ public TokenServiceEnum getTokenService() { } + /** + * The name of the token service. + * + * @param tokenService + */ @JsonProperty(JSON_PROPERTY_TOKEN_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenService(TokenServiceEnum tokenService) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalData3DSecure.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalData3DSecure.java index 7be8317ba..c52544a3d 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalData3DSecure.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalData3DSecure.java @@ -75,6 +75,11 @@ public String getCardHolderInfo() { } + /** + * Information provided by the issuer to the cardholder. If this field is present, you need to display this information to the cardholder. + * + * @param cardHolderInfo + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_INFO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderInfo(String cardHolderInfo) { @@ -100,6 +105,11 @@ public String getCavv() { } + /** + * The Cardholder Authentication Verification Value (CAVV) for the 3D Secure authentication session, as a Base64-encoded 20-byte array. + * + * @param cavv + */ @JsonProperty(JSON_PROPERTY_CAVV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavv(String cavv) { @@ -125,6 +135,11 @@ public String getCavvAlgorithm() { } + /** + * The CAVV algorithm used. + * + * @param cavvAlgorithm + */ @JsonProperty(JSON_PROPERTY_CAVV_ALGORITHM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCavvAlgorithm(String cavvAlgorithm) { @@ -150,6 +165,11 @@ public String getScaExemptionRequested() { } + /** + * Shows the [exemption type](https://docs.adyen.com/payments-fundamentals/psd2-sca-compliance-and-implementation-guide#specifypreferenceinyourapirequest) that Adyen requested for the payment. Possible values: * **lowValue** * **secureCorporate** * **trustedBeneficiary** * **transactionRiskAnalysis** + * + * @param scaExemptionRequested + */ @JsonProperty(JSON_PROPERTY_SCA_EXEMPTION_REQUESTED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScaExemptionRequested(String scaExemptionRequested) { @@ -175,6 +195,11 @@ public Boolean getThreeds2CardEnrolled() { } + /** + * Indicates whether a card is enrolled for 3D Secure 2. + * + * @param threeds2CardEnrolled + */ @JsonProperty(JSON_PROPERTY_THREEDS2_CARD_ENROLLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeds2CardEnrolled(Boolean threeds2CardEnrolled) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataBillingAddress.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataBillingAddress.java index 9aba4a9a5..aebaed324 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataBillingAddress.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataBillingAddress.java @@ -79,6 +79,11 @@ public String getBillingAddressCity() { } + /** + * The billing address city passed in the payment request. + * + * @param billingAddressCity + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressCity(String billingAddressCity) { @@ -104,6 +109,11 @@ public String getBillingAddressCountry() { } + /** + * The billing address country passed in the payment request. Example: NL + * + * @param billingAddressCountry + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressCountry(String billingAddressCountry) { @@ -129,6 +139,11 @@ public String getBillingAddressHouseNumberOrName() { } + /** + * The billing address house number or name passed in the payment request. + * + * @param billingAddressHouseNumberOrName + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressHouseNumberOrName(String billingAddressHouseNumberOrName) { @@ -154,6 +169,11 @@ public String getBillingAddressPostalCode() { } + /** + * The billing address postal code passed in the payment request. Example: 1011 DJ + * + * @param billingAddressPostalCode + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressPostalCode(String billingAddressPostalCode) { @@ -179,6 +199,11 @@ public String getBillingAddressStateOrProvince() { } + /** + * The billing address state or province passed in the payment request. Example: NH + * + * @param billingAddressStateOrProvince + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressStateOrProvince(String billingAddressStateOrProvince) { @@ -204,6 +229,11 @@ public String getBillingAddressStreet() { } + /** + * The billing address street passed in the payment request. + * + * @param billingAddressStreet + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddressStreet(String billingAddressStreet) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCard.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCard.java index f798729b4..ce0ba2557 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCard.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCard.java @@ -87,6 +87,11 @@ public String getCardBin() { } + /** + * The first six digits of the card number. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with a six-digit BIN. Example: 521234 + * + * @param cardBin + */ @JsonProperty(JSON_PROPERTY_CARD_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardBin(String cardBin) { @@ -112,6 +117,11 @@ public String getCardHolderName() { } + /** + * The cardholder name passed in the payment request. + * + * @param cardHolderName + */ @JsonProperty(JSON_PROPERTY_CARD_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardHolderName(String cardHolderName) { @@ -137,6 +147,11 @@ public String getCardIssuingBank() { } + /** + * The bank or the financial institution granting lines of credit through card association branded payment cards. This information can be included when available. + * + * @param cardIssuingBank + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingBank(String cardIssuingBank) { @@ -162,6 +177,11 @@ public String getCardIssuingCountry() { } + /** + * The country where the card was issued. Example: US + * + * @param cardIssuingCountry + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingCountry(String cardIssuingCountry) { @@ -187,6 +207,11 @@ public String getCardIssuingCurrency() { } + /** + * The currency in which the card is issued, if this information is available. Provided as the currency code or currency number from the ISO-4217 standard. Example: USD + * + * @param cardIssuingCurrency + */ @JsonProperty(JSON_PROPERTY_CARD_ISSUING_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardIssuingCurrency(String cardIssuingCurrency) { @@ -212,6 +237,11 @@ public String getCardPaymentMethod() { } + /** + * The card payment method used for the transaction. Example: amex + * + * @param cardPaymentMethod + */ @JsonProperty(JSON_PROPERTY_CARD_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardPaymentMethod(String cardPaymentMethod) { @@ -237,6 +267,11 @@ public String getCardSummary() { } + /** + * The last four digits of a card number. > Returned only in case of a card payment. + * + * @param cardSummary + */ @JsonProperty(JSON_PROPERTY_CARD_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCardSummary(String cardSummary) { @@ -262,6 +297,11 @@ public String getIssuerBin() { } + /** + * The first eight digits of the card number. Only returned if the card number is 16 digits or more. This is the [Bank Identification Number (BIN)](https://docs.adyen.com/get-started-with-adyen/payment-glossary#bank-identification-number-bin) for card numbers with an eight-digit BIN. Example: 52123423 + * + * @param issuerBin + */ @JsonProperty(JSON_PROPERTY_ISSUER_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerBin(String issuerBin) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCommon.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCommon.java index 4c7a09a77..c420d310c 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCommon.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataCommon.java @@ -363,6 +363,11 @@ public String getAcquirerAccountCode() { } + /** + * The name of the Adyen acquirer account. Example: PayPalSandbox_TestAcquirer > Only relevant for PayPal transactions. + * + * @param acquirerAccountCode + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerAccountCode(String acquirerAccountCode) { @@ -388,6 +393,11 @@ public String getAcquirerCode() { } + /** + * The name of the acquirer processing the payment request. Example: TestPmmAcquirer + * + * @param acquirerCode + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerCode(String acquirerCode) { @@ -413,6 +423,11 @@ public String getAcquirerReference() { } + /** + * The reference number that can be used for reconciliation in case a non-Adyen acquirer is used for settlement. Example: 7C9N3FNBKT9 + * + * @param acquirerReference + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerReference(String acquirerReference) { @@ -438,6 +453,11 @@ public String getAlias() { } + /** + * The Adyen alias of the card. Example: H167852639363479 + * + * @param alias + */ @JsonProperty(JSON_PROPERTY_ALIAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlias(String alias) { @@ -463,6 +483,11 @@ public String getAliasType() { } + /** + * The type of the card alias. Example: Default + * + * @param aliasType + */ @JsonProperty(JSON_PROPERTY_ALIAS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAliasType(String aliasType) { @@ -488,6 +513,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised successfully, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. Example: 58747 + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -513,6 +543,11 @@ public String getAuthorisationMid() { } + /** + * Merchant ID known by the acquirer. + * + * @param authorisationMid + */ @JsonProperty(JSON_PROPERTY_AUTHORISATION_MID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisationMid(String authorisationMid) { @@ -538,6 +573,11 @@ public String getAuthorisedAmountCurrency() { } + /** + * The currency of the authorised amount, as a three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param authorisedAmountCurrency + */ @JsonProperty(JSON_PROPERTY_AUTHORISED_AMOUNT_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisedAmountCurrency(String authorisedAmountCurrency) { @@ -563,6 +603,11 @@ public String getAuthorisedAmountValue() { } + /** + * Value of the amount authorised. This amount is represented in minor units according to the [following table](https://docs.adyen.com/development-resources/currency-codes). + * + * @param authorisedAmountValue + */ @JsonProperty(JSON_PROPERTY_AUTHORISED_AMOUNT_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthorisedAmountValue(String authorisedAmountValue) { @@ -588,6 +633,11 @@ public String getAvsResult() { } + /** + * The AVS result code of the payment, which provides information about the outcome of the AVS check. For possible values, see [AVS](https://docs.adyen.com/risk-management/configure-standard-risk-rules/consistency-rules#billing-address-does-not-match-cardholder-address-avs). + * + * @param avsResult + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResult(String avsResult) { @@ -613,6 +663,11 @@ public String getAvsResultRaw() { } + /** + * Raw AVS result received from the acquirer, where available. Example: D + * + * @param avsResultRaw + */ @JsonProperty(JSON_PROPERTY_AVS_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAvsResultRaw(String avsResultRaw) { @@ -638,6 +693,11 @@ public String getBic() { } + /** + * BIC of a bank account. Example: TESTNL01 > Only relevant for SEPA Direct Debit transactions. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -663,6 +723,11 @@ public String getCoBrandedWith() { } + /** + * Includes the co-branded card information. + * + * @param coBrandedWith + */ @JsonProperty(JSON_PROPERTY_CO_BRANDED_WITH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCoBrandedWith(String coBrandedWith) { @@ -688,6 +753,11 @@ public String getCvcResult() { } + /** + * The result of CVC verification. + * + * @param cvcResult + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResult(String cvcResult) { @@ -713,6 +783,11 @@ public String getCvcResultRaw() { } + /** + * The raw result of CVC verification. + * + * @param cvcResultRaw + */ @JsonProperty(JSON_PROPERTY_CVC_RESULT_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvcResultRaw(String cvcResultRaw) { @@ -738,6 +813,11 @@ public String getDsTransID() { } + /** + * Supported for 3D Secure 2. The unique transaction identifier assigned by the DS to identify a single transaction. + * + * @param dsTransID + */ @JsonProperty(JSON_PROPERTY_DS_TRANS_I_D) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDsTransID(String dsTransID) { @@ -763,6 +843,11 @@ public String getEci() { } + /** + * The Electronic Commerce Indicator returned from the schemes for the 3DS payment session. Example: 02 + * + * @param eci + */ @JsonProperty(JSON_PROPERTY_ECI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEci(String eci) { @@ -788,6 +873,11 @@ public String getExpiryDate() { } + /** + * The expiry date on the card. Example: 6/2016 > Returned only in case of a card payment. + * + * @param expiryDate + */ @JsonProperty(JSON_PROPERTY_EXPIRY_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryDate(String expiryDate) { @@ -813,6 +903,11 @@ public String getExtraCostsCurrency() { } + /** + * The currency of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. Example: EUR + * + * @param extraCostsCurrency + */ @JsonProperty(JSON_PROPERTY_EXTRA_COSTS_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtraCostsCurrency(String extraCostsCurrency) { @@ -838,6 +933,11 @@ public String getExtraCostsValue() { } + /** + * The value of the extra amount charged due to additional amounts set in the skin used in the HPP payment request. The amount is in minor units. + * + * @param extraCostsValue + */ @JsonProperty(JSON_PROPERTY_EXTRA_COSTS_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExtraCostsValue(String extraCostsValue) { @@ -863,6 +963,11 @@ public String getFraudCheckItemNrFraudCheckname() { } + /** + * The fraud score due to a particular fraud check. The fraud check name is found in the key of the key-value pair. + * + * @param fraudCheckItemNrFraudCheckname + */ @JsonProperty(JSON_PROPERTY_FRAUD_CHECK_ITEM_NR_FRAUD_CHECKNAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudCheckItemNrFraudCheckname(String fraudCheckItemNrFraudCheckname) { @@ -888,6 +993,11 @@ public String getFraudManualReview() { } + /** + * Indicates if the payment is sent to manual review. + * + * @param fraudManualReview + */ @JsonProperty(JSON_PROPERTY_FRAUD_MANUAL_REVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudManualReview(String fraudManualReview) { @@ -913,6 +1023,11 @@ public FraudResultTypeEnum getFraudResultType() { } + /** + * The fraud result properties of the payment. + * + * @param fraudResultType + */ @JsonProperty(JSON_PROPERTY_FRAUD_RESULT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudResultType(FraudResultTypeEnum fraudResultType) { @@ -938,6 +1053,11 @@ public String getFundingSource() { } + /** + * Information regarding the funding type of the card. The possible return values are: * CHARGE * CREDIT * DEBIT * PREPAID * PREPAID_RELOADABLE * PREPAID_NONRELOADABLE * DEFFERED_DEBIT > This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. For receiving this field in the notification, enable **Include Funding Source** in **Notifications** > **Additional settings**. + * + * @param fundingSource + */ @JsonProperty(JSON_PROPERTY_FUNDING_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundingSource(String fundingSource) { @@ -963,6 +1083,11 @@ public String getFundsAvailability() { } + /** + * Indicates availability of funds. Visa: * \"I\" (fast funds are supported) * \"N\" (otherwise) Mastercard: * \"I\" (product type is Prepaid or Debit, or issuing country is in CEE/HGEM list) * \"N\" (otherwise) > Returned when you verify a card BIN or estimate costs, and only if payoutEligible is \"Y\" or \"D\". + * + * @param fundsAvailability + */ @JsonProperty(JSON_PROPERTY_FUNDS_AVAILABILITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFundsAvailability(String fundsAvailability) { @@ -988,6 +1113,11 @@ public String getInferredRefusalReason() { } + /** + * Provides the more granular indication of why a transaction was refused. When a transaction fails with either \"Refused\", \"Restricted Card\", \"Transaction Not Permitted\", \"Not supported\" or \"DeclinedNon Generic\" refusalReason from the issuer, Adyen cross references its PSP-wide data for extra insight into the refusal reason. If an inferred refusal reason is available, the `inferredRefusalReason`, field is populated and the `refusalReason`, is set to \"Not Supported\". Possible values: * 3D Secure Mandated * Closed Account * ContAuth Not Supported * CVC Mandated * Ecommerce Not Allowed * Crossborder Not Supported * Card Updated * Low Authrate Bin * Non-reloadable prepaid card + * + * @param inferredRefusalReason + */ @JsonProperty(JSON_PROPERTY_INFERRED_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInferredRefusalReason(String inferredRefusalReason) { @@ -1013,6 +1143,11 @@ public String getIsCardCommercial() { } + /** + * Indicates if the card is used for business purposes only. + * + * @param isCardCommercial + */ @JsonProperty(JSON_PROPERTY_IS_CARD_COMMERCIAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIsCardCommercial(String isCardCommercial) { @@ -1038,6 +1173,11 @@ public String getIssuerCountry() { } + /** + * The issuing country of the card based on the BIN list that Adyen maintains. Example: JP + * + * @param issuerCountry + */ @JsonProperty(JSON_PROPERTY_ISSUER_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssuerCountry(String issuerCountry) { @@ -1063,6 +1203,11 @@ public String getLiabilityShift() { } + /** + * A Boolean value indicating whether a liability shift was offered for this payment. + * + * @param liabilityShift + */ @JsonProperty(JSON_PROPERTY_LIABILITY_SHIFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLiabilityShift(String liabilityShift) { @@ -1088,6 +1233,11 @@ public String getMcBankNetReferenceNumber() { } + /** + * The `mcBankNetReferenceNumber`, is a minimum of six characters and a maximum of nine characters long. > Contact Support Team to enable this field. + * + * @param mcBankNetReferenceNumber + */ @JsonProperty(JSON_PROPERTY_MC_BANK_NET_REFERENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcBankNetReferenceNumber(String mcBankNetReferenceNumber) { @@ -1113,6 +1263,11 @@ public String getMerchantAdviceCode() { } + /** + * The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried. For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes). + * + * @param merchantAdviceCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ADVICE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAdviceCode(String merchantAdviceCode) { @@ -1138,6 +1293,11 @@ public String getMerchantReference() { } + /** + * The reference provided for the transaction. + * + * @param merchantReference + */ @JsonProperty(JSON_PROPERTY_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantReference(String merchantReference) { @@ -1163,6 +1323,11 @@ public String getNetworkTxReference() { } + /** + * Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -1188,6 +1353,11 @@ public String getOwnerName() { } + /** + * The owner name of a bank account. Only relevant for SEPA Direct Debit transactions. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -1213,6 +1383,11 @@ public String getPaymentAccountReference() { } + /** + * The Payment Account Reference (PAR) value links a network token with the underlying primary account number (PAN). The PAR value consists of 29 uppercase alphanumeric characters. + * + * @param paymentAccountReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_ACCOUNT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentAccountReference(String paymentAccountReference) { @@ -1238,6 +1413,11 @@ public String getPaymentMethod() { } + /** + * The payment method used in the transaction. + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(String paymentMethod) { @@ -1263,6 +1443,11 @@ public String getPaymentMethodVariant() { } + /** + * The Adyen sub-variant of the payment method used for the payment request. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). Example: mcpro + * + * @param paymentMethodVariant + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodVariant(String paymentMethodVariant) { @@ -1288,6 +1473,11 @@ public String getPayoutEligible() { } + /** + * Indicates whether a payout is eligible or not for this card. Visa: * \"Y\" * \"N\" Mastercard: * \"Y\" (domestic and cross-border) * \"D\" (only domestic) * \"N\" (no MoneySend) * \"U\" (unknown) + * + * @param payoutEligible + */ @JsonProperty(JSON_PROPERTY_PAYOUT_ELIGIBLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPayoutEligible(String payoutEligible) { @@ -1313,6 +1503,11 @@ public String getRealtimeAccountUpdaterStatus() { } + /** + * The response code from the Real Time Account Updater service. Possible return values are: * CardChanged * CardExpiryChanged * CloseAccount * ContactCardAccountHolder + * + * @param realtimeAccountUpdaterStatus + */ @JsonProperty(JSON_PROPERTY_REALTIME_ACCOUNT_UPDATER_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRealtimeAccountUpdaterStatus(String realtimeAccountUpdaterStatus) { @@ -1338,6 +1533,11 @@ public String getReceiptFreeText() { } + /** + * Message to be displayed on the terminal. + * + * @param receiptFreeText + */ @JsonProperty(JSON_PROPERTY_RECEIPT_FREE_TEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceiptFreeText(String receiptFreeText) { @@ -1363,6 +1563,11 @@ public String getRecurringContractTypes() { } + /** + * The recurring contract types applicable to the transaction. + * + * @param recurringContractTypes + */ @JsonProperty(JSON_PROPERTY_RECURRING_CONTRACT_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringContractTypes(String recurringContractTypes) { @@ -1388,6 +1593,11 @@ public String getRecurringFirstPspReference() { } + /** + * The `pspReference`, of the first recurring payment that created the recurring detail. This functionality requires additional configuration on Adyen's end. To enable it, contact the Support Team. + * + * @param recurringFirstPspReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_FIRST_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFirstPspReference(String recurringFirstPspReference) { @@ -1413,6 +1623,11 @@ public String getRecurringRecurringDetailReference() { } + /** + * The reference that uniquely identifies the recurring transaction. + * + * @param recurringRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringRecurringDetailReference(String recurringRecurringDetailReference) { @@ -1438,6 +1653,11 @@ public String getRecurringShopperReference() { } + /** + * The provided reference of the shopper for a recurring transaction. + * + * @param recurringShopperReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringShopperReference(String recurringShopperReference) { @@ -1463,6 +1683,11 @@ public RecurringProcessingModelEnum getRecurringProcessingModel() { } + /** + * The processing model used for the recurring transaction. + * + * @param recurringProcessingModel + */ @JsonProperty(JSON_PROPERTY_RECURRING_PROCESSING_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringProcessingModel(RecurringProcessingModelEnum recurringProcessingModel) { @@ -1488,6 +1713,11 @@ public String getReferred() { } + /** + * If the payment is referred, this field is set to true. This field is unavailable if the payment is referred and is usually not returned with ecommerce transactions. Example: true + * + * @param referred + */ @JsonProperty(JSON_PROPERTY_REFERRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReferred(String referred) { @@ -1513,6 +1743,11 @@ public String getRefusalReasonRaw() { } + /** + * Raw refusal reason received from the acquirer, where available. Example: AUTHORISED + * + * @param refusalReasonRaw + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReasonRaw(String refusalReasonRaw) { @@ -1538,6 +1773,11 @@ public String getRequestAmount() { } + /** + * The amount of the payment request. + * + * @param requestAmount + */ @JsonProperty(JSON_PROPERTY_REQUEST_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestAmount(String requestAmount) { @@ -1563,6 +1803,11 @@ public String getRequestCurrencyCode() { } + /** + * The currency of the payment request. + * + * @param requestCurrencyCode + */ @JsonProperty(JSON_PROPERTY_REQUEST_CURRENCY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestCurrencyCode(String requestCurrencyCode) { @@ -1588,6 +1833,11 @@ public String getShopperInteraction() { } + /** + * The shopper interaction type of the payment request. Example: Ecommerce + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(String shopperInteraction) { @@ -1613,6 +1863,11 @@ public String getShopperReference() { } + /** + * The shopperReference passed in the payment request. Example: AdyenTestShopperXX + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -1638,6 +1893,11 @@ public String getTerminalId() { } + /** + * The terminal ID used in a point-of-sale payment. Example: 06022622 + * + * @param terminalId + */ @JsonProperty(JSON_PROPERTY_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalId(String terminalId) { @@ -1663,6 +1923,11 @@ public String getThreeDAuthenticated() { } + /** + * A Boolean value indicating whether 3DS authentication was completed on this payment. Example: true + * + * @param threeDAuthenticated + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticated(String threeDAuthenticated) { @@ -1688,6 +1953,11 @@ public String getThreeDAuthenticatedResponse() { } + /** + * The raw 3DS authentication result from the card issuer. Example: N + * + * @param threeDAuthenticatedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_AUTHENTICATED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDAuthenticatedResponse(String threeDAuthenticatedResponse) { @@ -1713,6 +1983,11 @@ public String getThreeDOffered() { } + /** + * A Boolean value indicating whether 3DS was offered for this payment. Example: true + * + * @param threeDOffered + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOffered(String threeDOffered) { @@ -1738,6 +2013,11 @@ public String getThreeDOfferedResponse() { } + /** + * The raw enrollment result from the 3DS directory services of the card schemes. Example: Y + * + * @param threeDOfferedResponse + */ @JsonProperty(JSON_PROPERTY_THREE_D_OFFERED_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDOfferedResponse(String threeDOfferedResponse) { @@ -1763,6 +2043,11 @@ public String getThreeDSVersion() { } + /** + * The 3D Secure 2 version. + * + * @param threeDSVersion + */ @JsonProperty(JSON_PROPERTY_THREE_D_S_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreeDSVersion(String threeDSVersion) { @@ -1788,6 +2073,11 @@ public String getVisaTransactionId() { } + /** + * The `visaTransactionId`, has a fixed length of 15 numeric characters. > Contact Support Team to enable this field. + * + * @param visaTransactionId + */ @JsonProperty(JSON_PROPERTY_VISA_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVisaTransactionId(String visaTransactionId) { @@ -1813,6 +2103,11 @@ public String getXid() { } + /** + * The 3DS transaction ID of the 3DS session sent in notifications. The value is Base64-encoded and is returned for transactions with directoryResponse 'N' or 'Y'. If you want to submit the xid in your 3D Secure 1 request, use the `mpiData.xid`, field. Example: ODgxNDc2MDg2MDExODk5MAAAAAA= + * + * @param xid + */ @JsonProperty(JSON_PROPERTY_XID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setXid(String xid) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataDomesticError.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataDomesticError.java index 20c22258b..98a7bbbc8 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataDomesticError.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataDomesticError.java @@ -63,6 +63,11 @@ public String getDomesticRefusalReasonRaw() { } + /** + * The reason the transaction was declined, given by the local issuer. Currently available for merchants in Japan. + * + * @param domesticRefusalReasonRaw + */ @JsonProperty(JSON_PROPERTY_DOMESTIC_REFUSAL_REASON_RAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomesticRefusalReasonRaw(String domesticRefusalReasonRaw) { @@ -88,6 +93,11 @@ public String getDomesticShopperAdvice() { } + /** + * The action the shopper should take, in a local language. Currently available in Japanese, for merchants in Japan. + * + * @param domesticShopperAdvice + */ @JsonProperty(JSON_PROPERTY_DOMESTIC_SHOPPER_ADVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDomesticShopperAdvice(String domesticShopperAdvice) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataInstallments.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataInstallments.java index a990f95b6..2c8ed69c1 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataInstallments.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataInstallments.java @@ -103,6 +103,11 @@ public String getInstallmentPaymentDataInstallmentType() { } + /** + * Type of installment. The value of `installmentType` should be **IssuerFinanced**. + * + * @param installmentPaymentDataInstallmentType + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_INSTALLMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataInstallmentType(String installmentPaymentDataInstallmentType) { @@ -128,6 +133,11 @@ public String getInstallmentPaymentDataOptionItemNrAnnualPercentageRate() { } + /** + * Annual interest rate. + * + * @param installmentPaymentDataOptionItemNrAnnualPercentageRate + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_ANNUAL_PERCENTAGE_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrAnnualPercentageRate(String installmentPaymentDataOptionItemNrAnnualPercentageRate) { @@ -153,6 +163,11 @@ public String getInstallmentPaymentDataOptionItemNrFirstInstallmentAmount() { } + /** + * First Installment Amount in minor units. + * + * @param installmentPaymentDataOptionItemNrFirstInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_FIRST_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrFirstInstallmentAmount(String installmentPaymentDataOptionItemNrFirstInstallmentAmount) { @@ -178,6 +193,11 @@ public String getInstallmentPaymentDataOptionItemNrInstallmentFee() { } + /** + * Installment fee amount in minor units. + * + * @param installmentPaymentDataOptionItemNrInstallmentFee + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_INSTALLMENT_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrInstallmentFee(String installmentPaymentDataOptionItemNrInstallmentFee) { @@ -203,6 +223,11 @@ public String getInstallmentPaymentDataOptionItemNrInterestRate() { } + /** + * Interest rate for the installment period. + * + * @param installmentPaymentDataOptionItemNrInterestRate + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_INTEREST_RATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrInterestRate(String installmentPaymentDataOptionItemNrInterestRate) { @@ -228,6 +253,11 @@ public String getInstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments() } + /** + * Maximum number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrMaximumNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_MAXIMUM_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrMaximumNumberOfInstallments(String installmentPaymentDataOptionItemNrMaximumNumberOfInstallments) { @@ -253,6 +283,11 @@ public String getInstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments() } + /** + * Minimum number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrMinimumNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_MINIMUM_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrMinimumNumberOfInstallments(String installmentPaymentDataOptionItemNrMinimumNumberOfInstallments) { @@ -278,6 +313,11 @@ public String getInstallmentPaymentDataOptionItemNrNumberOfInstallments() { } + /** + * Total number of installments possible for this payment. + * + * @param installmentPaymentDataOptionItemNrNumberOfInstallments + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_NUMBER_OF_INSTALLMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrNumberOfInstallments(String installmentPaymentDataOptionItemNrNumberOfInstallments) { @@ -303,6 +343,11 @@ public String getInstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount() } + /** + * Subsequent Installment Amount in minor units. + * + * @param installmentPaymentDataOptionItemNrSubsequentInstallmentAmount + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_SUBSEQUENT_INSTALLMENT_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrSubsequentInstallmentAmount(String installmentPaymentDataOptionItemNrSubsequentInstallmentAmount) { @@ -328,6 +373,11 @@ public String getInstallmentPaymentDataOptionItemNrTotalAmountDue() { } + /** + * Total amount in minor units. + * + * @param installmentPaymentDataOptionItemNrTotalAmountDue + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_OPTION_ITEM_NR_TOTAL_AMOUNT_DUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataOptionItemNrTotalAmountDue(String installmentPaymentDataOptionItemNrTotalAmountDue) { @@ -353,6 +403,11 @@ public String getInstallmentPaymentDataPaymentOptions() { } + /** + * Possible values: * PayInInstallmentsOnly * PayInFullOnly * PayInFullOrInstallments + * + * @param installmentPaymentDataPaymentOptions + */ @JsonProperty(JSON_PROPERTY_INSTALLMENT_PAYMENT_DATA_PAYMENT_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentPaymentDataPaymentOptions(String installmentPaymentDataPaymentOptions) { @@ -378,6 +433,11 @@ public String getInstallmentsValue() { } + /** + * The number of installments that the payment amount should be charged with. Example: 5 > Only relevant for card payments in countries that support installments. + * + * @param installmentsValue + */ @JsonProperty(JSON_PROPERTY_INSTALLMENTS_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstallmentsValue(String installmentsValue) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataNetworkTokens.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataNetworkTokens.java index 28484339b..7e1b734d6 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataNetworkTokens.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataNetworkTokens.java @@ -67,6 +67,11 @@ public String getNetworkTokenAvailable() { } + /** + * Indicates whether a network token is available for the specified card. + * + * @param networkTokenAvailable + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_AVAILABLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenAvailable(String networkTokenAvailable) { @@ -92,6 +97,11 @@ public String getNetworkTokenBin() { } + /** + * The Bank Identification Number of a tokenized card, which is the first six digits of a card number. + * + * @param networkTokenBin + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_BIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenBin(String networkTokenBin) { @@ -117,6 +127,11 @@ public String getNetworkTokenTokenSummary() { } + /** + * The last four digits of a network token. + * + * @param networkTokenTokenSummary + */ @JsonProperty(JSON_PROPERTY_NETWORK_TOKEN_TOKEN_SUMMARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTokenTokenSummary(String networkTokenTokenSummary) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataOpi.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataOpi.java index d2fecc56a..208807278 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataOpi.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataOpi.java @@ -59,6 +59,11 @@ public String getOpiTransToken() { } + /** + * Returned in the response if you included `opi.includeTransToken: true` in an ecommerce payment request. This contains an Oracle Payment Interface token that you can store in your Oracle Opera database to identify tokenized ecommerce transactions. For more information and required settings, see [Oracle Opera](https://docs.adyen.com/plugins/oracle-opera#opi-token-ecommerce). + * + * @param opiTransToken + */ @JsonProperty(JSON_PROPERTY_OPI_TRANS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOpiTransToken(String opiTransToken) { diff --git a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataSepa.java b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataSepa.java index 8f3d908cc..6eda7a647 100644 --- a/src/main/java/com/adyen/model/payout/ResponseAdditionalDataSepa.java +++ b/src/main/java/com/adyen/model/payout/ResponseAdditionalDataSepa.java @@ -67,6 +67,11 @@ public String getSepadirectdebitDateOfSignature() { } + /** + * The transaction signature date. Format: yyyy-MM-dd + * + * @param sepadirectdebitDateOfSignature + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_DATE_OF_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitDateOfSignature(String sepadirectdebitDateOfSignature) { @@ -92,6 +97,11 @@ public String getSepadirectdebitMandateId() { } + /** + * Its value corresponds to the pspReference value of the transaction. + * + * @param sepadirectdebitMandateId + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_MANDATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitMandateId(String sepadirectdebitMandateId) { @@ -117,6 +127,11 @@ public String getSepadirectdebitSequenceType() { } + /** + * This field can take one of the following values: * OneOff: (OOFF) Direct debit instruction to initiate exactly one direct debit transaction. * First: (FRST) Initial/first collection in a series of direct debit instructions. * Recurring: (RCUR) Direct debit instruction to carry out regular direct debit transactions initiated by the creditor. * Final: (FNAL) Last/final collection in a series of direct debit instructions. Example: OOFF + * + * @param sepadirectdebitSequenceType + */ @JsonProperty(JSON_PROPERTY_SEPADIRECTDEBIT_SEQUENCE_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSepadirectdebitSequenceType(String sepadirectdebitSequenceType) { diff --git a/src/main/java/com/adyen/model/payout/ServiceError.java b/src/main/java/com/adyen/model/payout/ServiceError.java index 70f7c4049..f5542e69d 100644 --- a/src/main/java/com/adyen/model/payout/ServiceError.java +++ b/src/main/java/com/adyen/model/payout/ServiceError.java @@ -90,6 +90,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -115,6 +120,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -140,6 +150,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -165,6 +180,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -190,6 +210,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -215,6 +240,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitRequest.java b/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitRequest.java index 35f81ab29..9f7ad2f20 100644 --- a/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitRequest.java +++ b/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitRequest.java @@ -184,6 +184,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular request. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -209,6 +214,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -234,6 +244,11 @@ public BankAccount getBank() { } + /** + * bank + * + * @param bank + */ @JsonProperty(JSON_PROPERTY_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBank(BankAccount bank) { @@ -259,6 +274,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -284,6 +304,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -309,6 +334,11 @@ public LocalDate getDateOfBirth() { } + /** + * The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. > This field is mandatory for natural persons. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -334,6 +364,11 @@ public EntityTypeEnum getEntityType() { } + /** + * The type of the entity the payout is processed for. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(EntityTypeEnum entityType) { @@ -359,6 +394,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -384,6 +424,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -409,6 +454,11 @@ public String getNationality() { } + /** + * The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). + * + * @param nationality + */ @JsonProperty(JSON_PROPERTY_NATIONALITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationality(String nationality) { @@ -434,6 +484,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -459,6 +514,11 @@ public String getReference() { } + /** + * The merchant reference for this payment. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is not a requirement. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -484,6 +544,11 @@ public String getSelectedBrand() { } + /** + * The name of the brand to make a payout to. For Paysafecard it must be set to `paysafecard`. + * + * @param selectedBrand + */ @JsonProperty(JSON_PROPERTY_SELECTED_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedBrand(String selectedBrand) { @@ -509,6 +574,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -534,6 +604,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -559,6 +634,11 @@ public String getShopperReference() { } + /** + * The shopper's reference for the payment transaction. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -584,6 +664,11 @@ public String getShopperStatement() { } + /** + * The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -609,6 +694,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -634,6 +724,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's phone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { diff --git a/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitResponse.java b/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitResponse.java index cdc21e358..73002e4c3 100644 --- a/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitResponse.java +++ b/src/main/java/com/adyen/model/payout/StoreDetailAndSubmitResponse.java @@ -82,6 +82,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be returned in a particular response. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -107,6 +112,11 @@ public String getPspReference() { } + /** + * A new reference to uniquely identify this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -132,6 +142,11 @@ public String getRefusalReason() { } + /** + * In case of refusal, an informational message for the reason. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -157,6 +172,11 @@ public String getResultCode() { } + /** + * The response: * In case of success is payout-submit-received. * In case of an error, an informational message is returned. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(String resultCode) { diff --git a/src/main/java/com/adyen/model/payout/StoreDetailRequest.java b/src/main/java/com/adyen/model/payout/StoreDetailRequest.java index 08f492637..7e5925733 100644 --- a/src/main/java/com/adyen/model/payout/StoreDetailRequest.java +++ b/src/main/java/com/adyen/model/payout/StoreDetailRequest.java @@ -171,6 +171,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular request. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -196,6 +201,11 @@ public BankAccount getBank() { } + /** + * bank + * + * @param bank + */ @JsonProperty(JSON_PROPERTY_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBank(BankAccount bank) { @@ -221,6 +231,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -246,6 +261,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -271,6 +291,11 @@ public LocalDate getDateOfBirth() { } + /** + * The date of birth. Format: [ISO-8601](https://www.w3.org/TR/NOTE-datetime); example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. > This field is mandatory for natural persons. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -296,6 +321,11 @@ public EntityTypeEnum getEntityType() { } + /** + * The type of the entity the payout is processed for. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(EntityTypeEnum entityType) { @@ -321,6 +351,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -346,6 +381,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -371,6 +411,11 @@ public String getNationality() { } + /** + * The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). + * + * @param nationality + */ @JsonProperty(JSON_PROPERTY_NATIONALITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationality(String nationality) { @@ -396,6 +441,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -421,6 +471,11 @@ public String getSelectedBrand() { } + /** + * The name of the brand to make a payout to. For Paysafecard it must be set to `paysafecard`. + * + * @param selectedBrand + */ @JsonProperty(JSON_PROPERTY_SELECTED_BRAND) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedBrand(String selectedBrand) { @@ -446,6 +501,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -471,6 +531,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -496,6 +561,11 @@ public String getShopperReference() { } + /** + * The shopper's reference for the payment transaction. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -521,6 +591,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -546,6 +621,11 @@ public String getTelephoneNumber() { } + /** + * The shopper's phone number. + * + * @param telephoneNumber + */ @JsonProperty(JSON_PROPERTY_TELEPHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTelephoneNumber(String telephoneNumber) { diff --git a/src/main/java/com/adyen/model/payout/StoreDetailResponse.java b/src/main/java/com/adyen/model/payout/StoreDetailResponse.java index 62036c901..b627ce169 100644 --- a/src/main/java/com/adyen/model/payout/StoreDetailResponse.java +++ b/src/main/java/com/adyen/model/payout/StoreDetailResponse.java @@ -82,6 +82,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be returned in a particular response. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -107,6 +112,11 @@ public String getPspReference() { } + /** + * A new reference to uniquely identify this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -132,6 +142,11 @@ public String getRecurringDetailReference() { } + /** + * The token which you can use later on for submitting the payout. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -157,6 +172,11 @@ public String getResultCode() { } + /** + * The result code of the transaction. `Success` indicates that the details were stored successfully. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(String resultCode) { diff --git a/src/main/java/com/adyen/model/payout/SubmitRequest.java b/src/main/java/com/adyen/model/payout/SubmitRequest.java index 41b91d616..0a0e33ebc 100644 --- a/src/main/java/com/adyen/model/payout/SubmitRequest.java +++ b/src/main/java/com/adyen/model/payout/SubmitRequest.java @@ -165,6 +165,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular request. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -190,6 +195,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -215,6 +225,11 @@ public LocalDate getDateOfBirth() { } + /** + * The date of birth. Format: ISO-8601; example: YYYY-MM-DD For Paysafecard it must be the same as used when registering the Paysafecard account. > This field is mandatory for natural persons. > This field is required to update the existing `dateOfBirth` that is associated with this recurring contract. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -240,6 +255,11 @@ public EntityTypeEnum getEntityType() { } + /** + * The type of the entity the payout is processed for. Allowed values: * NaturalPerson * Company > This field is required to update the existing `entityType` that is associated with this recurring contract. + * + * @param entityType + */ @JsonProperty(JSON_PROPERTY_ENTITY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEntityType(EntityTypeEnum entityType) { @@ -265,6 +285,11 @@ public Integer getFraudOffset() { } + /** + * An integer value that is added to the normal fraud score. The value can be either positive or negative. + * + * @param fraudOffset + */ @JsonProperty(JSON_PROPERTY_FRAUD_OFFSET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFraudOffset(Integer fraudOffset) { @@ -290,6 +315,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier you want to process the transaction request with. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -315,6 +345,11 @@ public String getNationality() { } + /** + * The shopper's nationality. A valid value is an ISO 2-character country code (e.g. 'NL'). > This field is required to update the existing nationality that is associated with this recurring contract. + * + * @param nationality + */ @JsonProperty(JSON_PROPERTY_NATIONALITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNationality(String nationality) { @@ -340,6 +375,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -365,6 +405,11 @@ public String getReference() { } + /** + * The merchant reference for this payout. This reference will be used in all communication to the merchant about the status of the payout. Although it is a good idea to make sure it is unique, this is not a requirement. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -390,6 +435,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` you want to use for this payout. You can use the value LATEST to select the most recently used recurring detail. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -415,6 +465,11 @@ public String getShopperEmail() { } + /** + * The shopper's email address. + * + * @param shopperEmail + */ @JsonProperty(JSON_PROPERTY_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperEmail(String shopperEmail) { @@ -440,6 +495,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -465,6 +525,11 @@ public String getShopperReference() { } + /** + * The shopper's reference for the payout transaction. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -490,6 +555,11 @@ public String getShopperStatement() { } + /** + * The description of this payout. This description is shown on the bank statement of the shopper (if this is supported by the chosen payment method). + * + * @param shopperStatement + */ @JsonProperty(JSON_PROPERTY_SHOPPER_STATEMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperStatement(String shopperStatement) { @@ -515,6 +585,11 @@ public String getSocialSecurityNumber() { } + /** + * The shopper's social security number. + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { diff --git a/src/main/java/com/adyen/model/payout/SubmitResponse.java b/src/main/java/com/adyen/model/payout/SubmitResponse.java index 697597682..87ba3a28f 100644 --- a/src/main/java/com/adyen/model/payout/SubmitResponse.java +++ b/src/main/java/com/adyen/model/payout/SubmitResponse.java @@ -82,6 +82,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be returned in a particular response. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -107,6 +112,11 @@ public String getPspReference() { } + /** + * A new reference to uniquely identify this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -132,6 +142,11 @@ public String getRefusalReason() { } + /** + * In case of refusal, an informational message for the reason. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -157,6 +172,11 @@ public String getResultCode() { } + /** + * The response: * In case of success, it is `payout-submit-received`. * In case of an error, an informational message is returned. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(String resultCode) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/posterminalmanagement/AbstractOpenApiSchema.java index e3803ea93..813409b10 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * diff --git a/src/main/java/com/adyen/model/posterminalmanagement/Address.java b/src/main/java/com/adyen/model/posterminalmanagement/Address.java index 371444a48..1db414a0d 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/Address.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/Address.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -80,6 +79,11 @@ public String getCity() { } + /** + * city + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -105,6 +109,11 @@ public String getCountryCode() { } + /** + * countryCode + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -130,6 +139,11 @@ public String getPostalCode() { } + /** + * postalCode + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -155,6 +169,11 @@ public String getStateOrProvince() { } + /** + * stateOrProvince + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -180,6 +199,11 @@ public String getStreetAddress() { } + /** + * streetAddress + * + * @param streetAddress + */ @JsonProperty(JSON_PROPERTY_STREET_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreetAddress(String streetAddress) { @@ -205,6 +229,11 @@ public String getStreetAddress2() { } + /** + * streetAddress2 + * + * @param streetAddress2 + */ @JsonProperty(JSON_PROPERTY_STREET_ADDRESS2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreetAddress2(String streetAddress2) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsRequest.java b/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsRequest.java index 7a2e02b68..b800f05ec 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsRequest.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsRequest.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -78,6 +77,11 @@ public String getCompanyAccount() { } + /** + * Your company account. To return terminals to the company inventory, specify only this parameter and the `terminals`. + * + * @param companyAccount + */ @JsonProperty(JSON_PROPERTY_COMPANY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyAccount(String companyAccount) { @@ -103,6 +107,11 @@ public String getMerchantAccount() { } + /** + * Name of the merchant account. Specify this parameter to assign terminals to this merchant account or to a store under this merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -128,6 +137,11 @@ public Boolean getMerchantInventory() { } + /** + * Boolean that indicates if you are assigning the terminals to the merchant inventory. Do not use when assigning terminals to a store. Required when assigning the terminal to a merchant account. - Set this to **true** to assign the terminals to the merchant inventory. This also means that the terminals cannot be boarded. - Set this to **false** to assign the terminals to the merchant account as in-store terminals. This makes the terminals ready to be boarded and to process payments through the specified merchant account. + * + * @param merchantInventory + */ @JsonProperty(JSON_PROPERTY_MERCHANT_INVENTORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantInventory(Boolean merchantInventory) { @@ -153,6 +167,11 @@ public String getStore() { } + /** + * The store code of the store that you want to assign the terminals to. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -183,6 +202,11 @@ public List getTerminals() { } + /** + * Array containing a list of terminal IDs that you want to assign or reassign to the merchant account or store, or that you want to return to the company inventory. For example, `[\"V400m-324689776\",\"P400Plus-329127412\"]`. + * + * @param terminals + */ @JsonProperty(JSON_PROPERTY_TERMINALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminals(List terminals) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsResponse.java b/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsResponse.java index 516ccf688..b54c20025 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsResponse.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/AssignTerminalsResponse.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -68,6 +67,11 @@ public Map getResults() { } + /** + * Array that returns a list of the terminals, and for each terminal the result of assigning it to an account or store. The results can be: - `Done`: The terminal has been assigned. - `AssignmentScheduled`: The terminal will be assigned asynschronously. - `RemoveConfigScheduled`: The terminal was previously assigned and boarded. Wait for the terminal to synchronize with the Adyen platform. For more information, refer to [Reassigning boarded terminals](https://docs.adyen.com/point-of-sale/managing-terminals/assign-terminals#reassign-boarded-terminals). - `Error`: There was an error when assigning the terminal. + * + * @param results + */ @JsonProperty(JSON_PROPERTY_RESULTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResults(Map results) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalRequest.java b/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalRequest.java index 95e7993fe..d6301025a 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalRequest.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalRequest.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -60,6 +59,11 @@ public String getTerminal() { } + /** + * The unique terminal ID in the format `[Device model]-[Serial number]`. For example, **V400m-324689776**. + * + * @param terminal + */ @JsonProperty(JSON_PROPERTY_TERMINAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminal(String terminal) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalResponse.java b/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalResponse.java index b65a82e77..096ebd408 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalResponse.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/FindTerminalResponse.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -76,6 +75,11 @@ public String getCompanyAccount() { } + /** + * The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account. + * + * @param companyAccount + */ @JsonProperty(JSON_PROPERTY_COMPANY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyAccount(String companyAccount) { @@ -101,6 +105,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that the terminal is associated with. If the response doesn't contain a `store` the terminal is assigned to this merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -126,6 +135,11 @@ public Boolean getMerchantInventory() { } + /** + * Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account. - If **true**, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded. - If **false**, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded. + * + * @param merchantInventory + */ @JsonProperty(JSON_PROPERTY_MERCHANT_INVENTORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantInventory(Boolean merchantInventory) { @@ -151,6 +165,11 @@ public String getStore() { } + /** + * The store code of the store that the terminal is assigned to. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -176,6 +195,11 @@ public String getTerminal() { } + /** + * The unique terminal ID. + * + * @param terminal + */ @JsonProperty(JSON_PROPERTY_TERMINAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminal(String terminal) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountRequest.java b/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountRequest.java index 2f1e9fd1f..c0e33727b 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountRequest.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountRequest.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -64,6 +63,11 @@ public String getCompanyAccount() { } + /** + * The company account. If you only specify this parameter, the response includes the stores of all merchant accounts that are associated with the company account. + * + * @param companyAccount + */ @JsonProperty(JSON_PROPERTY_COMPANY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyAccount(String companyAccount) { @@ -89,6 +93,11 @@ public String getMerchantAccount() { } + /** + * The merchant account. With this parameter, the response only includes the stores of the specified merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountResponse.java b/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountResponse.java index 8f0ce3ece..670f88b34 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountResponse.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/GetStoresUnderAccountResponse.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -71,6 +70,11 @@ public List getStores() { } + /** + * Array that returns a list of all stores for the specified merchant account, or for all merchant accounts under the company account. + * + * @param stores + */ @JsonProperty(JSON_PROPERTY_STORES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStores(List stores) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsRequest.java b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsRequest.java index ce6662b36..f06ea8282 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsRequest.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsRequest.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -60,6 +59,11 @@ public String getTerminal() { } + /** + * The unique terminal ID in the format `[Device model]-[Serial number]`. For example, **V400m-324689776**. + * + * @param terminal + */ @JsonProperty(JSON_PROPERTY_TERMINAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminal(String terminal) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsResponse.java b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsResponse.java index 8350673a2..f755897e6 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsResponse.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalDetailsResponse.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -213,6 +212,11 @@ public String getBluetoothIp() { } + /** + * The Bluetooth IP address of the terminal. + * + * @param bluetoothIp + */ @JsonProperty(JSON_PROPERTY_BLUETOOTH_IP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBluetoothIp(String bluetoothIp) { @@ -238,6 +242,11 @@ public String getBluetoothMac() { } + /** + * The Bluetooth MAC address of the terminal. + * + * @param bluetoothMac + */ @JsonProperty(JSON_PROPERTY_BLUETOOTH_MAC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBluetoothMac(String bluetoothMac) { @@ -263,6 +272,11 @@ public String getCompanyAccount() { } + /** + * The company account that the terminal is associated with. If this is the only account level shown in the response, the terminal is assigned to the inventory of the company account. + * + * @param companyAccount + */ @JsonProperty(JSON_PROPERTY_COMPANY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyAccount(String companyAccount) { @@ -288,6 +302,11 @@ public String getCountry() { } + /** + * The country where the terminal is used. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -313,6 +332,11 @@ public String getDeviceModel() { } + /** + * The model name of the terminal. + * + * @param deviceModel + */ @JsonProperty(JSON_PROPERTY_DEVICE_MODEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDeviceModel(String deviceModel) { @@ -338,6 +362,11 @@ public Boolean getDhcpEnabled() { } + /** + * Indicates whether assigning IP addresses through a DHCP server is enabled on the terminal. + * + * @param dhcpEnabled + */ @JsonProperty(JSON_PROPERTY_DHCP_ENABLED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDhcpEnabled(Boolean dhcpEnabled) { @@ -363,6 +392,11 @@ public String getDisplayLabel() { } + /** + * The label shown on the status bar of the display. This label (if any) is specified in your Customer Area. + * + * @param displayLabel + */ @JsonProperty(JSON_PROPERTY_DISPLAY_LABEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisplayLabel(String displayLabel) { @@ -388,6 +422,11 @@ public String getEthernetIp() { } + /** + * The terminal's IP address in your Ethernet network. + * + * @param ethernetIp + */ @JsonProperty(JSON_PROPERTY_ETHERNET_IP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEthernetIp(String ethernetIp) { @@ -413,6 +452,11 @@ public String getEthernetMac() { } + /** + * The terminal's MAC address in your Ethernet network. + * + * @param ethernetMac + */ @JsonProperty(JSON_PROPERTY_ETHERNET_MAC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEthernetMac(String ethernetMac) { @@ -438,6 +482,11 @@ public String getFirmwareVersion() { } + /** + * The software release currently in use on the terminal. + * + * @param firmwareVersion + */ @JsonProperty(JSON_PROPERTY_FIRMWARE_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirmwareVersion(String firmwareVersion) { @@ -463,6 +512,11 @@ public String getIccid() { } + /** + * The integrated circuit card identifier (ICCID) of the SIM card in the terminal. + * + * @param iccid + */ @JsonProperty(JSON_PROPERTY_ICCID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIccid(String iccid) { @@ -488,6 +542,11 @@ public OffsetDateTime getLastActivityDateTime() { } + /** + * Date and time of the last activity on the terminal. Not included when the last activity was more than 14 days ago. + * + * @param lastActivityDateTime + */ @JsonProperty(JSON_PROPERTY_LAST_ACTIVITY_DATE_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastActivityDateTime(OffsetDateTime lastActivityDateTime) { @@ -513,6 +572,11 @@ public OffsetDateTime getLastTransactionDateTime() { } + /** + * Date and time of the last transaction on the terminal. Not included when the last transaction was more than 14 days ago. + * + * @param lastTransactionDateTime + */ @JsonProperty(JSON_PROPERTY_LAST_TRANSACTION_DATE_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastTransactionDateTime(OffsetDateTime lastTransactionDateTime) { @@ -538,6 +602,11 @@ public String getLinkNegotiation() { } + /** + * The Ethernet link negotiation that the terminal uses: - `auto`: Auto-negotiation - `100full`: 100 Mbps full duplex + * + * @param linkNegotiation + */ @JsonProperty(JSON_PROPERTY_LINK_NEGOTIATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinkNegotiation(String linkNegotiation) { @@ -563,6 +632,11 @@ public String getMerchantAccount() { } + /** + * The merchant account that the terminal is associated with. If the response doesn't contain a `store` the terminal is assigned to this merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -588,6 +662,11 @@ public Boolean getMerchantInventory() { } + /** + * Boolean that indicates if the terminal is assigned to the merchant inventory. This is returned when the terminal is assigned to a merchant account. - If **true**, this indicates that the terminal is in the merchant inventory. This also means that the terminal cannot be boarded. - If **false**, this indicates that the terminal is assigned to the merchant account as an in-store terminal. This means that the terminal is ready to be boarded, or is already boarded. + * + * @param merchantInventory + */ @JsonProperty(JSON_PROPERTY_MERCHANT_INVENTORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantInventory(Boolean merchantInventory) { @@ -613,6 +692,11 @@ public String getPermanentTerminalId() { } + /** + * The permanent terminal ID. + * + * @param permanentTerminalId + */ @JsonProperty(JSON_PROPERTY_PERMANENT_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPermanentTerminalId(String permanentTerminalId) { @@ -638,6 +722,11 @@ public String getSerialNumber() { } + /** + * The serial number of the terminal. + * + * @param serialNumber + */ @JsonProperty(JSON_PROPERTY_SERIAL_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSerialNumber(String serialNumber) { @@ -663,6 +752,11 @@ public String getSimStatus() { } + /** + * On a terminal that supports 3G or 4G connectivity, indicates the status of the SIM card in the terminal: ACTIVE or INVENTORY. + * + * @param simStatus + */ @JsonProperty(JSON_PROPERTY_SIM_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSimStatus(String simStatus) { @@ -688,6 +782,11 @@ public String getStore() { } + /** + * The store code of the store that the terminal is assigned to. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -713,6 +812,11 @@ public Store getStoreDetails() { } + /** + * storeDetails + * + * @param storeDetails + */ @JsonProperty(JSON_PROPERTY_STORE_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoreDetails(Store storeDetails) { @@ -738,6 +842,11 @@ public String getTerminal() { } + /** + * The unique terminal ID. + * + * @param terminal + */ @JsonProperty(JSON_PROPERTY_TERMINAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminal(String terminal) { @@ -763,6 +872,11 @@ public TerminalStatusEnum getTerminalStatus() { } + /** + * The status of the terminal: - `OnlineToday`, `OnlineLast1Day`, `OnlineLast2Days` etcetera to `OnlineLast7Days`: Indicates when in the past week the terminal was last online. - `SwitchedOff`: Indicates it was more than a week ago that the terminal was last online. - `ReAssignToInventoryPending`, `ReAssignToStorePending`, `ReAssignToMerchantInventoryPending`: Indicates the terminal is scheduled to be reassigned. + * + * @param terminalStatus + */ @JsonProperty(JSON_PROPERTY_TERMINAL_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerminalStatus(TerminalStatusEnum terminalStatus) { @@ -788,6 +902,11 @@ public String getWifiIp() { } + /** + * The terminal's IP address in your Wi-Fi network. + * + * @param wifiIp + */ @JsonProperty(JSON_PROPERTY_WIFI_IP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWifiIp(String wifiIp) { @@ -813,6 +932,11 @@ public String getWifiMac() { } + /** + * The terminal's MAC address in your Wi-Fi network. + * + * @param wifiMac + */ @JsonProperty(JSON_PROPERTY_WIFI_MAC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setWifiMac(String wifiMac) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountRequest.java b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountRequest.java index b6fea67d8..b034924a8 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountRequest.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountRequest.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -68,6 +67,11 @@ public String getCompanyAccount() { } + /** + * Your company account. If you only specify this parameter, the response includes all terminals at all account levels. + * + * @param companyAccount + */ @JsonProperty(JSON_PROPERTY_COMPANY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyAccount(String companyAccount) { @@ -93,6 +97,11 @@ public String getMerchantAccount() { } + /** + * The merchant account. This is required if you are retrieving the terminals assigned to a store.If you don't specify a `store` the response includes the terminals assigned to the specified merchant account and the terminals assigned to the stores under this merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -118,6 +127,11 @@ public String getStore() { } + /** + * The store code of the store. With this parameter, the response only includes the terminals assigned to the specified store. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountResponse.java b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountResponse.java index f65cd6bd3..7d517054e 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountResponse.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/GetTerminalsUnderAccountResponse.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -71,6 +70,11 @@ public String getCompanyAccount() { } + /** + * Your company account. + * + * @param companyAccount + */ @JsonProperty(JSON_PROPERTY_COMPANY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCompanyAccount(String companyAccount) { @@ -104,6 +108,11 @@ public List getInventoryTerminals() { } + /** + * Array that returns a list of all terminals that are in the inventory of the company account. + * + * @param inventoryTerminals + */ @JsonProperty(JSON_PROPERTY_INVENTORY_TERMINALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInventoryTerminals(List inventoryTerminals) { @@ -137,6 +146,11 @@ public List getMerchantAccounts() { } + /** + * Array that returns a list of all merchant accounts belonging to the company account. + * + * @param merchantAccounts + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccounts(List merchantAccounts) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/MerchantAccount.java b/src/main/java/com/adyen/model/posterminalmanagement/MerchantAccount.java index 0f38eab27..fd53d21bf 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/MerchantAccount.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/MerchantAccount.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -83,6 +82,11 @@ public List getInStoreTerminals() { } + /** + * List of terminals assigned to this merchant account as in-store terminals. This means that the terminal is ready to be boarded, or is already boarded. + * + * @param inStoreTerminals + */ @JsonProperty(JSON_PROPERTY_IN_STORE_TERMINALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInStoreTerminals(List inStoreTerminals) { @@ -116,6 +120,11 @@ public List getInventoryTerminals() { } + /** + * List of terminals assigned to the inventory of this merchant account. + * + * @param inventoryTerminals + */ @JsonProperty(JSON_PROPERTY_INVENTORY_TERMINALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInventoryTerminals(List inventoryTerminals) { @@ -141,6 +150,11 @@ public String getMerchantAccount() { } + /** + * The merchant account. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -174,6 +188,11 @@ public List getStores() { } + /** + * Array of stores under this merchant account. + * + * @param stores + */ @JsonProperty(JSON_PROPERTY_STORES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStores(List stores) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/ServiceError.java b/src/main/java/com/adyen/model/posterminalmanagement/ServiceError.java index 20a232d98..24a721908 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/ServiceError.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/ServiceError.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -76,6 +75,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -101,6 +105,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -126,6 +135,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -151,6 +165,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -176,6 +195,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/posterminalmanagement/Store.java b/src/main/java/com/adyen/model/posterminalmanagement/Store.java index aba99838a..71fcecb3e 100644 --- a/src/main/java/com/adyen/model/posterminalmanagement/Store.java +++ b/src/main/java/com/adyen/model/posterminalmanagement/Store.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -83,6 +82,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -108,6 +112,11 @@ public String getDescription() { } + /** + * The description of the store. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -141,6 +150,11 @@ public List getInStoreTerminals() { } + /** + * The list of terminals assigned to the store. + * + * @param inStoreTerminals + */ @JsonProperty(JSON_PROPERTY_IN_STORE_TERMINALS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInStoreTerminals(List inStoreTerminals) { @@ -166,6 +180,11 @@ public String getMerchantAccountCode() { } + /** + * The code of the merchant account. + * + * @param merchantAccountCode + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccountCode(String merchantAccountCode) { @@ -191,6 +210,11 @@ public String getStatus() { } + /** + * The status of the store: - `PreActive`: the store has been created, but not yet activated. - `Active`: the store has been activated. This means you can process payments for this store. - `Inactive`: the store is currently not active. - `InactiveWithModifications`: the store is currently not active, but payment modifications such as refunds are possible. - `Closed`: the store has been closed. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { @@ -216,6 +240,11 @@ public String getStore() { } + /** + * The code of the store. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/recurring/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/recurring/AbstractOpenApiSchema.java index b4eac0ddb..221be97c1 100644 --- a/src/main/java/com/adyen/model/recurring/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/recurring/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * diff --git a/src/main/java/com/adyen/model/recurring/Address.java b/src/main/java/com/adyen/model/recurring/Address.java index 7ef691247..c80569890 100644 --- a/src/main/java/com/adyen/model/recurring/Address.java +++ b/src/main/java/com/adyen/model/recurring/Address.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -80,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. Maximum length: 3000 characters. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -105,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO-3166-1 alpha-2 country code. For example, **US**. > If you don't know the country or are not collecting the country from the shopper, provide `country` as `ZZ`. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -130,6 +139,11 @@ public String getHouseNumberOrName() { } + /** + * The number or name of the house. Maximum length: 3000 characters. + * + * @param houseNumberOrName + */ @JsonProperty(JSON_PROPERTY_HOUSE_NUMBER_OR_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHouseNumberOrName(String houseNumberOrName) { @@ -155,6 +169,11 @@ public String getPostalCode() { } + /** + * A maximum of five digits for an address in the US, or a maximum of ten characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -180,6 +199,11 @@ public String getStateOrProvince() { } + /** + * The two-character ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { @@ -205,6 +229,11 @@ public String getStreet() { } + /** + * The name of the street. Maximum length: 3000 characters. > The house number should not be included in this field; it should be separately provided via `houseNumberOrName`. + * + * @param street + */ @JsonProperty(JSON_PROPERTY_STREET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStreet(String street) { diff --git a/src/main/java/com/adyen/model/recurring/Amount.java b/src/main/java/com/adyen/model/recurring/Amount.java index 2addd20ef..46b9cd6c5 100644 --- a/src/main/java/com/adyen/model/recurring/Amount.java +++ b/src/main/java/com/adyen/model/recurring/Amount.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -89,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/recurring/BankAccount.java b/src/main/java/com/adyen/model/recurring/BankAccount.java index 95e47b305..39ad36097 100644 --- a/src/main/java/com/adyen/model/recurring/BankAccount.java +++ b/src/main/java/com/adyen/model/recurring/BankAccount.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -92,6 +91,11 @@ public String getBankAccountNumber() { } + /** + * The bank account number (without separators). + * + * @param bankAccountNumber + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccountNumber(String bankAccountNumber) { @@ -117,6 +121,11 @@ public String getBankCity() { } + /** + * The bank city. + * + * @param bankCity + */ @JsonProperty(JSON_PROPERTY_BANK_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCity(String bankCity) { @@ -142,6 +151,11 @@ public String getBankLocationId() { } + /** + * The location id of the bank. The field value is `nil` in most cases. + * + * @param bankLocationId + */ @JsonProperty(JSON_PROPERTY_BANK_LOCATION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankLocationId(String bankLocationId) { @@ -167,6 +181,11 @@ public String getBankName() { } + /** + * The name of the bank. + * + * @param bankName + */ @JsonProperty(JSON_PROPERTY_BANK_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankName(String bankName) { @@ -192,6 +211,11 @@ public String getBic() { } + /** + * The [Business Identifier Code](https://en.wikipedia.org/wiki/ISO_9362) (BIC) is the SWIFT address assigned to a bank. The field value is `nil` in most cases. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -217,6 +241,11 @@ public String getCountryCode() { } + /** + * Country code where the bank is located. A valid value is an ISO two-character country code (e.g. 'NL'). + * + * @param countryCode + */ @JsonProperty(JSON_PROPERTY_COUNTRY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryCode(String countryCode) { @@ -242,6 +271,11 @@ public String getIban() { } + /** + * The [International Bank Account Number](https://en.wikipedia.org/wiki/International_Bank_Account_Number) (IBAN). + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -267,6 +301,11 @@ public String getOwnerName() { } + /** + * The name of the bank account holder. If you submit a name with non-Latin characters, we automatically replace some of them with corresponding Latin characters to meet the FATF recommendations. For example: * χ12 is converted to ch12. * üA is converted to euA. * Peter Møller is converted to Peter Mller, because banks don't accept 'ø'. After replacement, the ownerName must have at least three alphanumeric characters (A-Z, a-z, 0-9), and at least one of them must be a valid Latin character (A-Z, a-z). For example: * John17 - allowed. * J17 - allowed. * 171 - not allowed. * John-7 - allowed. > If provided details don't match the required format, the response returns the error message: 203 'Invalid bank account holder name'. + * + * @param ownerName + */ @JsonProperty(JSON_PROPERTY_OWNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOwnerName(String ownerName) { @@ -292,6 +331,11 @@ public String getTaxId() { } + /** + * The bank account holder's tax ID. + * + * @param taxId + */ @JsonProperty(JSON_PROPERTY_TAX_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTaxId(String taxId) { diff --git a/src/main/java/com/adyen/model/recurring/Card.java b/src/main/java/com/adyen/model/recurring/Card.java index fb560bded..c0bd34371 100644 --- a/src/main/java/com/adyen/model/recurring/Card.java +++ b/src/main/java/com/adyen/model/recurring/Card.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -88,6 +87,11 @@ public String getCvc() { } + /** + * The [card verification code](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid) (1-20 characters). Depending on the card brand, it is known also as: * CVV2/CVC2 – length: 3 digits * CID – length: 4 digits > If you are using [Client-Side Encryption](https://docs.adyen.com/classic-integration/cse-integration-ecommerce), the CVC code is present in the encrypted data. You must never post the card details to the server. > This field must be always present in a [one-click payment request](https://docs.adyen.com/classic-integration/recurring-payments). > When this value is returned in a response, it is always empty because it is not stored. + * + * @param cvc + */ @JsonProperty(JSON_PROPERTY_CVC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCvc(String cvc) { @@ -113,6 +117,11 @@ public String getExpiryMonth() { } + /** + * The card expiry month. Format: 2 digits, zero-padded for single digits. For example: * 03 = March * 11 = November + * + * @param expiryMonth + */ @JsonProperty(JSON_PROPERTY_EXPIRY_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryMonth(String expiryMonth) { @@ -138,6 +147,11 @@ public String getExpiryYear() { } + /** + * The card expiry year. Format: 4 digits. For example: 2020 + * + * @param expiryYear + */ @JsonProperty(JSON_PROPERTY_EXPIRY_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setExpiryYear(String expiryYear) { @@ -163,6 +177,11 @@ public String getHolderName() { } + /** + * The name of the cardholder, as printed on the card. + * + * @param holderName + */ @JsonProperty(JSON_PROPERTY_HOLDER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHolderName(String holderName) { @@ -188,6 +207,11 @@ public String getIssueNumber() { } + /** + * The issue number of the card (for some UK debit cards only). + * + * @param issueNumber + */ @JsonProperty(JSON_PROPERTY_ISSUE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIssueNumber(String issueNumber) { @@ -213,6 +237,11 @@ public String getNumber() { } + /** + * The card number (4-19 characters). Do not use any separators. When this value is returned in a response, only the last 4 digits of the card number are returned. + * + * @param number + */ @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNumber(String number) { @@ -238,6 +267,11 @@ public String getStartMonth() { } + /** + * The month component of the start date (for some UK debit cards only). + * + * @param startMonth + */ @JsonProperty(JSON_PROPERTY_START_MONTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartMonth(String startMonth) { @@ -263,6 +297,11 @@ public String getStartYear() { } + /** + * The year component of the start date (for some UK debit cards only). + * + * @param startYear + */ @JsonProperty(JSON_PROPERTY_START_YEAR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStartYear(String startYear) { diff --git a/src/main/java/com/adyen/model/recurring/CreatePermitRequest.java b/src/main/java/com/adyen/model/recurring/CreatePermitRequest.java index abc00debf..195a0249e 100644 --- a/src/main/java/com/adyen/model/recurring/CreatePermitRequest.java +++ b/src/main/java/com/adyen/model/recurring/CreatePermitRequest.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -75,6 +74,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -105,6 +109,11 @@ public List getPermits() { } + /** + * The permits to create for this recurring contract. + * + * @param permits + */ @JsonProperty(JSON_PROPERTY_PERMITS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPermits(List permits) { @@ -130,6 +139,11 @@ public String getRecurringDetailReference() { } + /** + * The recurring contract the new permits will use. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -155,6 +169,11 @@ public String getShopperReference() { } + /** + * The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID). + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/recurring/CreatePermitResult.java b/src/main/java/com/adyen/model/recurring/CreatePermitResult.java index 4cb43ba75..7cae876bc 100644 --- a/src/main/java/com/adyen/model/recurring/CreatePermitResult.java +++ b/src/main/java/com/adyen/model/recurring/CreatePermitResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -75,6 +74,11 @@ public List getPermitResultList() { } + /** + * List of new permits. + * + * @param permitResultList + */ @JsonProperty(JSON_PROPERTY_PERMIT_RESULT_LIST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPermitResultList(List permitResultList) { @@ -100,6 +104,11 @@ public String getPspReference() { } + /** + * A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { diff --git a/src/main/java/com/adyen/model/recurring/DisablePermitRequest.java b/src/main/java/com/adyen/model/recurring/DisablePermitRequest.java index d9e47622f..012b7c6b1 100644 --- a/src/main/java/com/adyen/model/recurring/DisablePermitRequest.java +++ b/src/main/java/com/adyen/model/recurring/DisablePermitRequest.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -89,6 +93,11 @@ public String getToken() { } + /** + * The permit token to disable. + * + * @param token + */ @JsonProperty(JSON_PROPERTY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToken(String token) { diff --git a/src/main/java/com/adyen/model/recurring/DisablePermitResult.java b/src/main/java/com/adyen/model/recurring/DisablePermitResult.java index 603d9273b..b13e9651b 100644 --- a/src/main/java/com/adyen/model/recurring/DisablePermitResult.java +++ b/src/main/java/com/adyen/model/recurring/DisablePermitResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getPspReference() { } + /** + * A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -89,6 +93,11 @@ public String getStatus() { } + /** + * Status of the disable request. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(String status) { diff --git a/src/main/java/com/adyen/model/recurring/DisableRequest.java b/src/main/java/com/adyen/model/recurring/DisableRequest.java index 8e32e1368..d03bcde3c 100644 --- a/src/main/java/com/adyen/model/recurring/DisableRequest.java +++ b/src/main/java/com/adyen/model/recurring/DisableRequest.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -72,6 +71,11 @@ public String getContract() { } + /** + * Specify the contract if you only want to disable a specific use. This field can be set to one of the following values, or to their combination (comma-separated): * ONECLICK * RECURRING * PAYOUT + * + * @param contract + */ @JsonProperty(JSON_PROPERTY_CONTRACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContract(String contract) { @@ -97,6 +101,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -122,6 +131,11 @@ public String getRecurringDetailReference() { } + /** + * The ID that uniquely identifies the recurring detail reference. If it is not provided, the whole recurring contract of the `shopperReference` will be disabled, which includes all recurring details. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -147,6 +161,11 @@ public String getShopperReference() { } + /** + * The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/recurring/DisableResult.java b/src/main/java/com/adyen/model/recurring/DisableResult.java index c6fba7088..dc581c580 100644 --- a/src/main/java/com/adyen/model/recurring/DisableResult.java +++ b/src/main/java/com/adyen/model/recurring/DisableResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -60,6 +59,11 @@ public String getResponse() { } + /** + * Depending on whether a specific recurring detail was in the request, result is either [detail-successfully-disabled] or [all-details-successfully-disabled]. + * + * @param response + */ @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponse(String response) { diff --git a/src/main/java/com/adyen/model/recurring/Name.java b/src/main/java/com/adyen/model/recurring/Name.java index c32c8fee5..e54749d1e 100644 --- a/src/main/java/com/adyen/model/recurring/Name.java +++ b/src/main/java/com/adyen/model/recurring/Name.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getFirstName() { } + /** + * The first name. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -89,6 +93,11 @@ public String getLastName() { } + /** + * The last name. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { diff --git a/src/main/java/com/adyen/model/recurring/NotifyShopperRequest.java b/src/main/java/com/adyen/model/recurring/NotifyShopperRequest.java index 0dfda9977..28989f2ef 100644 --- a/src/main/java/com/adyen/model/recurring/NotifyShopperRequest.java +++ b/src/main/java/com/adyen/model/recurring/NotifyShopperRequest.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -93,6 +92,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -118,6 +122,11 @@ public String getBillingDate() { } + /** + * Date on which the subscription amount will be debited from the shopper. In YYYY-MM-DD format + * + * @param billingDate + */ @JsonProperty(JSON_PROPERTY_BILLING_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingDate(String billingDate) { @@ -143,6 +152,11 @@ public String getBillingSequenceNumber() { } + /** + * Sequence of the debit. Depends on Frequency and Billing Attempts Rule. + * + * @param billingSequenceNumber + */ @JsonProperty(JSON_PROPERTY_BILLING_SEQUENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingSequenceNumber(String billingSequenceNumber) { @@ -168,6 +182,11 @@ public String getDisplayedReference() { } + /** + * Reference of Pre-debit notification that is displayed to the shopper. Optional field. Maps to reference if missing + * + * @param displayedReference + */ @JsonProperty(JSON_PROPERTY_DISPLAYED_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisplayedReference(String displayedReference) { @@ -193,6 +212,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -218,6 +242,11 @@ public String getRecurringDetailReference() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -243,6 +272,11 @@ public String getReference() { } + /** + * Pre-debit notification reference sent by the merchant. This is a mandatory field + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -268,6 +302,11 @@ public String getShopperReference() { } + /** + * The ID that uniquely identifies the shopper. This `shopperReference` must be the same as the `shopperReference` used in the initial payment. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -293,6 +332,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the `recurringDetailReference` returned in the response when you created the token. + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { diff --git a/src/main/java/com/adyen/model/recurring/NotifyShopperResult.java b/src/main/java/com/adyen/model/recurring/NotifyShopperResult.java index 89742ab23..cf4fac35c 100644 --- a/src/main/java/com/adyen/model/recurring/NotifyShopperResult.java +++ b/src/main/java/com/adyen/model/recurring/NotifyShopperResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -84,6 +83,11 @@ public String getDisplayedReference() { } + /** + * Reference of Pre-debit notification that is displayed to the shopper + * + * @param displayedReference + */ @JsonProperty(JSON_PROPERTY_DISPLAYED_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDisplayedReference(String displayedReference) { @@ -109,6 +113,11 @@ public String getMessage() { } + /** + * A simple description of the `resultCode`. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -134,6 +143,11 @@ public String getPspReference() { } + /** + * The unique reference that is associated with the request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -159,6 +173,11 @@ public String getReference() { } + /** + * Reference of Pre-debit notification sent in my the merchant + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -184,6 +203,11 @@ public String getResultCode() { } + /** + * The code indicating the status of notification. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(String resultCode) { @@ -209,6 +233,11 @@ public String getShopperNotificationReference() { } + /** + * The unique reference for the request sent downstream. + * + * @param shopperNotificationReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NOTIFICATION_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperNotificationReference(String shopperNotificationReference) { @@ -234,6 +263,11 @@ public String getStoredPaymentMethodId() { } + /** + * This is the recurringDetailReference returned in the response when token was created + * + * @param storedPaymentMethodId + */ @JsonProperty(JSON_PROPERTY_STORED_PAYMENT_METHOD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStoredPaymentMethodId(String storedPaymentMethodId) { diff --git a/src/main/java/com/adyen/model/recurring/Permit.java b/src/main/java/com/adyen/model/recurring/Permit.java index 2d2b2c302..07c6d476c 100644 --- a/src/main/java/com/adyen/model/recurring/Permit.java +++ b/src/main/java/com/adyen/model/recurring/Permit.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -78,6 +77,11 @@ public String getPartnerId() { } + /** + * Partner ID (when using the permit-per-partner token sharing model). + * + * @param partnerId + */ @JsonProperty(JSON_PROPERTY_PARTNER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPartnerId(String partnerId) { @@ -103,6 +107,11 @@ public String getProfileReference() { } + /** + * The profile to apply to this permit (when using the shared permits model). + * + * @param profileReference + */ @JsonProperty(JSON_PROPERTY_PROFILE_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProfileReference(String profileReference) { @@ -128,6 +137,11 @@ public PermitRestriction getRestriction() { } + /** + * restriction + * + * @param restriction + */ @JsonProperty(JSON_PROPERTY_RESTRICTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRestriction(PermitRestriction restriction) { @@ -153,6 +167,11 @@ public String getResultKey() { } + /** + * The key to link permit requests to permit results. + * + * @param resultKey + */ @JsonProperty(JSON_PROPERTY_RESULT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultKey(String resultKey) { @@ -178,6 +197,11 @@ public OffsetDateTime getValidTillDate() { } + /** + * The expiry date for this permit. + * + * @param validTillDate + */ @JsonProperty(JSON_PROPERTY_VALID_TILL_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidTillDate(OffsetDateTime validTillDate) { diff --git a/src/main/java/com/adyen/model/recurring/PermitRestriction.java b/src/main/java/com/adyen/model/recurring/PermitRestriction.java index 0741e1fd8..df0798659 100644 --- a/src/main/java/com/adyen/model/recurring/PermitRestriction.java +++ b/src/main/java/com/adyen/model/recurring/PermitRestriction.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -69,6 +68,11 @@ public Amount getMaxAmount() { } + /** + * maxAmount + * + * @param maxAmount + */ @JsonProperty(JSON_PROPERTY_MAX_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaxAmount(Amount maxAmount) { @@ -94,6 +98,11 @@ public Amount getSingleTransactionLimit() { } + /** + * singleTransactionLimit + * + * @param singleTransactionLimit + */ @JsonProperty(JSON_PROPERTY_SINGLE_TRANSACTION_LIMIT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSingleTransactionLimit(Amount singleTransactionLimit) { @@ -119,6 +128,11 @@ public Boolean getSingleUse() { } + /** + * Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed. + * + * @param singleUse + */ @JsonProperty(JSON_PROPERTY_SINGLE_USE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSingleUse(Boolean singleUse) { diff --git a/src/main/java/com/adyen/model/recurring/PermitResult.java b/src/main/java/com/adyen/model/recurring/PermitResult.java index cbd7bf975..fb37df902 100644 --- a/src/main/java/com/adyen/model/recurring/PermitResult.java +++ b/src/main/java/com/adyen/model/recurring/PermitResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getResultKey() { } + /** + * The key to link permit requests to permit results. + * + * @param resultKey + */ @JsonProperty(JSON_PROPERTY_RESULT_KEY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultKey(String resultKey) { @@ -89,6 +93,11 @@ public String getToken() { } + /** + * The permit token which is used to make payments by the partner company. + * + * @param token + */ @JsonProperty(JSON_PROPERTY_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setToken(String token) { diff --git a/src/main/java/com/adyen/model/recurring/Recurring.java b/src/main/java/com/adyen/model/recurring/Recurring.java index 3c672dbaa..cf836b210 100644 --- a/src/main/java/com/adyen/model/recurring/Recurring.java +++ b/src/main/java/com/adyen/model/recurring/Recurring.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -153,6 +152,11 @@ public ContractEnum getContract() { } + /** + * The type of recurring contract to be used. Possible values: * `ONECLICK` – Payment details can be used to initiate a one-click payment, where the shopper enters the [card security code (CVC/CVV)](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-security-code-cvc-cvv-cid). * `RECURRING` – Payment details can be used without the card security code to initiate [card-not-present transactions](https://docs.adyen.com/payments-fundamentals/payment-glossary#card-not-present-cnp). * `ONECLICK,RECURRING` – Payment details can be used regardless of whether the shopper is on your site or not. * `PAYOUT` – Payment details can be used to [make a payout](https://docs.adyen.com/online-payments/online-payouts). + * + * @param contract + */ @JsonProperty(JSON_PROPERTY_CONTRACT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContract(ContractEnum contract) { @@ -178,6 +182,11 @@ public String getRecurringDetailName() { } + /** + * A descriptive name for this detail. + * + * @param recurringDetailName + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailName(String recurringDetailName) { @@ -203,6 +212,11 @@ public OffsetDateTime getRecurringExpiry() { } + /** + * Date after which no further authorisations shall be performed. Only for 3D Secure 2. + * + * @param recurringExpiry + */ @JsonProperty(JSON_PROPERTY_RECURRING_EXPIRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringExpiry(OffsetDateTime recurringExpiry) { @@ -228,6 +242,11 @@ public String getRecurringFrequency() { } + /** + * Minimum number of days between authorisations. Only for 3D Secure 2. + * + * @param recurringFrequency + */ @JsonProperty(JSON_PROPERTY_RECURRING_FREQUENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringFrequency(String recurringFrequency) { @@ -253,6 +272,11 @@ public TokenServiceEnum getTokenService() { } + /** + * The name of the token service. + * + * @param tokenService + */ @JsonProperty(JSON_PROPERTY_TOKEN_SERVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenService(TokenServiceEnum tokenService) { diff --git a/src/main/java/com/adyen/model/recurring/RecurringDetail.java b/src/main/java/com/adyen/model/recurring/RecurringDetail.java index 89b3a5249..b590ab192 100644 --- a/src/main/java/com/adyen/model/recurring/RecurringDetail.java +++ b/src/main/java/com/adyen/model/recurring/RecurringDetail.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -142,6 +141,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be returned in a particular response. The additionalData object consists of entries, each of which includes the key and value. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -167,6 +171,11 @@ public String getAlias() { } + /** + * The alias of the credit card number. Applies only to recurring contracts storing credit card details + * + * @param alias + */ @JsonProperty(JSON_PROPERTY_ALIAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAlias(String alias) { @@ -192,6 +201,11 @@ public String getAliasType() { } + /** + * The alias type of the credit card number. Applies only to recurring contracts storing credit card details. + * + * @param aliasType + */ @JsonProperty(JSON_PROPERTY_ALIAS_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAliasType(String aliasType) { @@ -217,6 +231,11 @@ public BankAccount getBank() { } + /** + * bank + * + * @param bank + */ @JsonProperty(JSON_PROPERTY_BANK) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBank(BankAccount bank) { @@ -242,6 +261,11 @@ public Address getBillingAddress() { } + /** + * billingAddress + * + * @param billingAddress + */ @JsonProperty(JSON_PROPERTY_BILLING_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBillingAddress(Address billingAddress) { @@ -267,6 +291,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -300,6 +329,11 @@ public List getContractTypes() { } + /** + * Types of recurring contracts. + * + * @param contractTypes + */ @JsonProperty(JSON_PROPERTY_CONTRACT_TYPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setContractTypes(List contractTypes) { @@ -325,6 +359,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date when the recurring details were created. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -350,6 +389,11 @@ public String getFirstPspReference() { } + /** + * The `pspReference` of the first recurring payment that created the recurring detail. + * + * @param firstPspReference + */ @JsonProperty(JSON_PROPERTY_FIRST_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstPspReference(String firstPspReference) { @@ -375,6 +419,11 @@ public String getName() { } + /** + * An optional descriptive name for this recurring detail. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -400,6 +449,11 @@ public String getNetworkTxReference() { } + /** + * Returned in the response if you are not tokenizing with Adyen and are using the Merchant-initiated transactions (MIT) framework from Mastercard or Visa. This contains either the Mastercard Trace ID or the Visa Transaction ID. + * + * @param networkTxReference + */ @JsonProperty(JSON_PROPERTY_NETWORK_TX_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNetworkTxReference(String networkTxReference) { @@ -425,6 +479,11 @@ public String getPaymentMethodVariant() { } + /** + * The type or sub-brand of a payment method used, e.g. Visa Debit, Visa Corporate, etc. For more information, refer to [PaymentMethodVariant](https://docs.adyen.com/development-resources/paymentmethodvariant). + * + * @param paymentMethodVariant + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethodVariant(String paymentMethodVariant) { @@ -450,6 +509,11 @@ public String getRecurringDetailReference() { } + /** + * The reference that uniquely identifies the recurring detail. + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -475,6 +539,11 @@ public Name getShopperName() { } + /** + * shopperName + * + * @param shopperName + */ @JsonProperty(JSON_PROPERTY_SHOPPER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperName(Name shopperName) { @@ -500,6 +569,11 @@ public String getSocialSecurityNumber() { } + /** + * A shopper's social security number (only in countries where it is legal to collect). + * + * @param socialSecurityNumber + */ @JsonProperty(JSON_PROPERTY_SOCIAL_SECURITY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSocialSecurityNumber(String socialSecurityNumber) { @@ -525,6 +599,11 @@ public TokenDetails getTokenDetails() { } + /** + * tokenDetails + * + * @param tokenDetails + */ @JsonProperty(JSON_PROPERTY_TOKEN_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenDetails(TokenDetails tokenDetails) { @@ -550,6 +629,11 @@ public String getVariant() { } + /** + * The payment method, such as “mc\", \"visa\", \"ideal\", \"paypal\". + * + * @param variant + */ @JsonProperty(JSON_PROPERTY_VARIANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setVariant(String variant) { diff --git a/src/main/java/com/adyen/model/recurring/RecurringDetailWrapper.java b/src/main/java/com/adyen/model/recurring/RecurringDetailWrapper.java index 9f6d40ae3..91485603d 100644 --- a/src/main/java/com/adyen/model/recurring/RecurringDetailWrapper.java +++ b/src/main/java/com/adyen/model/recurring/RecurringDetailWrapper.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -61,6 +60,11 @@ public RecurringDetail getRecurringDetail() { } + /** + * recurringDetail + * + * @param recurringDetail + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetail(RecurringDetail recurringDetail) { diff --git a/src/main/java/com/adyen/model/recurring/RecurringDetailsRequest.java b/src/main/java/com/adyen/model/recurring/RecurringDetailsRequest.java index acc56b0c4..fd97e96e0 100644 --- a/src/main/java/com/adyen/model/recurring/RecurringDetailsRequest.java +++ b/src/main/java/com/adyen/model/recurring/RecurringDetailsRequest.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -69,6 +68,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier you want to process the (transaction) request with. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -94,6 +98,11 @@ public Recurring getRecurring() { } + /** + * recurring + * + * @param recurring + */ @JsonProperty(JSON_PROPERTY_RECURRING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurring(Recurring recurring) { @@ -119,6 +128,11 @@ public String getShopperReference() { } + /** + * The reference you use to uniquely identify the shopper (e.g. user ID or account ID). + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/recurring/RecurringDetailsResult.java b/src/main/java/com/adyen/model/recurring/RecurringDetailsResult.java index e09111994..06877e998 100644 --- a/src/main/java/com/adyen/model/recurring/RecurringDetailsResult.java +++ b/src/main/java/com/adyen/model/recurring/RecurringDetailsResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -76,6 +75,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date when the recurring details were created. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -109,6 +113,11 @@ public List getDetails() { } + /** + * Payment details stored for recurring payments. + * + * @param details + */ @JsonProperty(JSON_PROPERTY_DETAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetails(List details) { @@ -134,6 +143,11 @@ public String getLastKnownShopperEmail() { } + /** + * The most recent email for this shopper (if available). + * + * @param lastKnownShopperEmail + */ @JsonProperty(JSON_PROPERTY_LAST_KNOWN_SHOPPER_EMAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastKnownShopperEmail(String lastKnownShopperEmail) { @@ -159,6 +173,11 @@ public String getShopperReference() { } + /** + * The reference you use to uniquely identify the shopper (e.g. user ID or account ID). + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterRequest.java b/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterRequest.java index bf6a9ab3a..3297f9618 100644 --- a/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterRequest.java +++ b/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterRequest.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -92,6 +91,11 @@ public Map getAdditionalData() { } + /** + * This field contains additional data, which may be required for a particular request. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -117,6 +121,11 @@ public Card getCard() { } + /** + * card + * + * @param card + */ @JsonProperty(JSON_PROPERTY_CARD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCard(Card card) { @@ -142,6 +151,11 @@ public String getMerchantAccount() { } + /** + * Account of the merchant. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -167,6 +181,11 @@ public String getReference() { } + /** + * A reference that merchants can apply for the call. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -192,6 +211,11 @@ public String getSelectedRecurringDetailReference() { } + /** + * The selected detail recurring reference. Optional if `card` is provided. + * + * @param selectedRecurringDetailReference + */ @JsonProperty(JSON_PROPERTY_SELECTED_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSelectedRecurringDetailReference(String selectedRecurringDetailReference) { @@ -217,6 +241,11 @@ public String getShopperReference() { } + /** + * The reference of the shopper that owns the recurring contract. Optional if `card` is provided. + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { diff --git a/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterResult.java b/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterResult.java index b6f1d605f..07db1a5a2 100644 --- a/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterResult.java +++ b/src/main/java/com/adyen/model/recurring/ScheduleAccountUpdaterResult.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -64,6 +63,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character unique reference associated with the transaction. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -89,6 +93,11 @@ public String getResult() { } + /** + * The result of scheduling an Account Updater. If scheduling was successful, this field returns **Success**; otherwise it contains the error message. + * + * @param result + */ @JsonProperty(JSON_PROPERTY_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResult(String result) { diff --git a/src/main/java/com/adyen/model/recurring/ServiceError.java b/src/main/java/com/adyen/model/recurring/ServiceError.java index 9863f2a97..a05fab7d8 100644 --- a/src/main/java/com/adyen/model/recurring/ServiceError.java +++ b/src/main/java/com/adyen/model/recurring/ServiceError.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -91,6 +90,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -116,6 +120,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -141,6 +150,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -166,6 +180,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -191,6 +210,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -216,6 +240,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/recurring/TokenDetails.java b/src/main/java/com/adyen/model/recurring/TokenDetails.java index eff617de3..27c042b70 100644 --- a/src/main/java/com/adyen/model/recurring/TokenDetails.java +++ b/src/main/java/com/adyen/model/recurring/TokenDetails.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -75,6 +74,11 @@ public Map getTokenData() { } + /** + * tokenData + * + * @param tokenData + */ @JsonProperty(JSON_PROPERTY_TOKEN_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenData(Map tokenData) { @@ -100,6 +104,11 @@ public String getTokenDataType() { } + /** + * tokenDataType + * + * @param tokenDataType + */ @JsonProperty(JSON_PROPERTY_TOKEN_DATA_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenDataType(String tokenDataType) { diff --git a/src/main/java/com/adyen/model/reportwebhooks/BalancePlatformNotificationResponse.java b/src/main/java/com/adyen/model/reportwebhooks/BalancePlatformNotificationResponse.java index 8425a78fa..c67de11fe 100644 --- a/src/main/java/com/adyen/model/reportwebhooks/BalancePlatformNotificationResponse.java +++ b/src/main/java/com/adyen/model/reportwebhooks/BalancePlatformNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationData.java b/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationData.java index 97483a22c..db9d1cb8d 100644 --- a/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationData.java +++ b/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationData.java @@ -85,6 +85,11 @@ public ResourceReference getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(ResourceReference accountHolder) { @@ -110,6 +115,11 @@ public ResourceReference getBalanceAccount() { } + /** + * balanceAccount + * + * @param balanceAccount + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccount(ResourceReference balanceAccount) { @@ -135,6 +145,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -160,6 +175,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -185,6 +205,11 @@ public String getDownloadUrl() { } + /** + * The URL at which you can download the report. To download, you must authenticate your GET request with your [API credentials](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/overview). + * + * @param downloadUrl + */ @JsonProperty(JSON_PROPERTY_DOWNLOAD_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDownloadUrl(String downloadUrl) { @@ -210,6 +235,11 @@ public String getFileName() { } + /** + * The filename of the report. + * + * @param fileName + */ @JsonProperty(JSON_PROPERTY_FILE_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFileName(String fileName) { @@ -235,6 +265,11 @@ public String getReportType() { } + /** + * Type of report. + * + * @param reportType + */ @JsonProperty(JSON_PROPERTY_REPORT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReportType(String reportType) { diff --git a/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationRequest.java b/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationRequest.java index feff3415b..7d7da9874 100644 --- a/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationRequest.java +++ b/src/main/java/com/adyen/model/reportwebhooks/ReportNotificationRequest.java @@ -101,6 +101,11 @@ public ReportNotificationData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(ReportNotificationData data) { @@ -126,6 +131,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -151,6 +161,11 @@ public TypeEnum getType() { } + /** + * Type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/reportwebhooks/Resource.java b/src/main/java/com/adyen/model/reportwebhooks/Resource.java index f17a53cdc..8a58f1934 100644 --- a/src/main/java/com/adyen/model/reportwebhooks/Resource.java +++ b/src/main/java/com/adyen/model/reportwebhooks/Resource.java @@ -68,6 +68,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -93,6 +98,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/reportwebhooks/ResourceReference.java b/src/main/java/com/adyen/model/reportwebhooks/ResourceReference.java index 01993396a..fa7f57b21 100644 --- a/src/main/java/com/adyen/model/reportwebhooks/ResourceReference.java +++ b/src/main/java/com/adyen/model/reportwebhooks/ResourceReference.java @@ -67,6 +67,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -92,6 +97,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -117,6 +127,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/storedvalue/AbstractOpenApiSchema.java b/src/main/java/com/adyen/model/storedvalue/AbstractOpenApiSchema.java index fc3a59f75..df40814f0 100644 --- a/src/main/java/com/adyen/model/storedvalue/AbstractOpenApiSchema.java +++ b/src/main/java/com/adyen/model/storedvalue/AbstractOpenApiSchema.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * diff --git a/src/main/java/com/adyen/model/storedvalue/Amount.java b/src/main/java/com/adyen/model/storedvalue/Amount.java index d08ebc8fd..ce485ff72 100644 --- a/src/main/java/com/adyen/model/storedvalue/Amount.java +++ b/src/main/java/com/adyen/model/storedvalue/Amount.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -64,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -89,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/storedvalue/ServiceError.java b/src/main/java/com/adyen/model/storedvalue/ServiceError.java index f8f14d020..391460948 100644 --- a/src/main/java/com/adyen/model/storedvalue/ServiceError.java +++ b/src/main/java/com/adyen/model/storedvalue/ServiceError.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -91,6 +90,11 @@ public Map getAdditionalData() { } + /** + * Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**. + * + * @param additionalData + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalData(Map additionalData) { @@ -116,6 +120,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -141,6 +150,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -166,6 +180,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -191,6 +210,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -216,6 +240,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckRequest.java b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckRequest.java index 131db12db..461691575 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckRequest.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckRequest.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -131,6 +130,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -156,6 +160,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -186,6 +195,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information if available + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -211,6 +225,11 @@ public String getRecurringDetailReference() { } + /** + * recurringDetailReference + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -236,6 +255,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -261,6 +285,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -286,6 +315,11 @@ public String getShopperReference() { } + /** + * shopperReference + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -311,6 +345,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckResponse.java b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckResponse.java index 98e3c0b42..fdc9f55de 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckResponse.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceCheckResponse.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -116,6 +115,11 @@ public Amount getCurrentBalance() { } + /** + * currentBalance + * + * @param currentBalance + */ @JsonProperty(JSON_PROPERTY_CURRENT_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrentBalance(Amount currentBalance) { @@ -141,6 +145,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -166,6 +175,11 @@ public String getRefusalReason() { } + /** + * If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -191,6 +205,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field. * **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. * **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -216,6 +235,11 @@ public String getThirdPartyRefusalReason() { } + /** + * Raw refusal reason received from the third party, where available + * + * @param thirdPartyRefusalReason + */ @JsonProperty(JSON_PROPERTY_THIRD_PARTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThirdPartyRefusalReason(String thirdPartyRefusalReason) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeRequest.java b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeRequest.java index 4508f5b64..72b72486f 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeRequest.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeRequest.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -135,6 +134,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -160,6 +164,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -190,6 +199,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information if available + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -215,6 +229,11 @@ public String getRecurringDetailReference() { } + /** + * recurringDetailReference + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -240,6 +259,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -265,6 +289,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -290,6 +319,11 @@ public String getShopperReference() { } + /** + * shopperReference + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -320,6 +354,11 @@ public Map getSourcePaymentMethod() { } + /** + * The collection that contains the source payment method and its specific information if available. Note that type should not be included since it is inferred from the (target) payment method + * + * @param sourcePaymentMethod + */ @JsonProperty(JSON_PROPERTY_SOURCE_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSourcePaymentMethod(Map sourcePaymentMethod) { @@ -345,6 +384,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeResponse.java b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeResponse.java index 7003e8aa7..eae68ba92 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeResponse.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueBalanceMergeResponse.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -120,6 +119,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -145,6 +149,11 @@ public Amount getCurrentBalance() { } + /** + * currentBalance + * + * @param currentBalance + */ @JsonProperty(JSON_PROPERTY_CURRENT_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrentBalance(Amount currentBalance) { @@ -170,6 +179,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -195,6 +209,11 @@ public String getRefusalReason() { } + /** + * If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -220,6 +239,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field. * **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. * **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -245,6 +269,11 @@ public String getThirdPartyRefusalReason() { } + /** + * Raw refusal reason received from the third party, where available + * + * @param thirdPartyRefusalReason + */ @JsonProperty(JSON_PROPERTY_THIRD_PARTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThirdPartyRefusalReason(String thirdPartyRefusalReason) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueIssueRequest.java b/src/main/java/com/adyen/model/storedvalue/StoredValueIssueRequest.java index 7bee46a05..8251ad17d 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueIssueRequest.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueIssueRequest.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -131,6 +130,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -156,6 +160,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -186,6 +195,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information if available + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -211,6 +225,11 @@ public String getRecurringDetailReference() { } + /** + * recurringDetailReference + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -236,6 +255,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -261,6 +285,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -286,6 +315,11 @@ public String getShopperReference() { } + /** + * shopperReference + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -311,6 +345,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueIssueResponse.java b/src/main/java/com/adyen/model/storedvalue/StoredValueIssueResponse.java index 6980409ec..30d4f334a 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueIssueResponse.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueIssueResponse.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -127,6 +126,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -152,6 +156,11 @@ public Amount getCurrentBalance() { } + /** + * currentBalance + * + * @param currentBalance + */ @JsonProperty(JSON_PROPERTY_CURRENT_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrentBalance(Amount currentBalance) { @@ -185,6 +194,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information if available + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -210,6 +224,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -235,6 +254,11 @@ public String getRefusalReason() { } + /** + * If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -260,6 +284,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field. * **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. * **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -285,6 +314,11 @@ public String getThirdPartyRefusalReason() { } + /** + * Raw refusal reason received from the third party, where available + * + * @param thirdPartyRefusalReason + */ @JsonProperty(JSON_PROPERTY_THIRD_PARTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThirdPartyRefusalReason(String thirdPartyRefusalReason) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueLoadRequest.java b/src/main/java/com/adyen/model/storedvalue/StoredValueLoadRequest.java index b9392d94b..a1a9ecea8 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueLoadRequest.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueLoadRequest.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -170,6 +169,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -195,6 +199,11 @@ public LoadTypeEnum getLoadType() { } + /** + * The type of load you are trying to do, when absent we default to 'Load' + * + * @param loadType + */ @JsonProperty(JSON_PROPERTY_LOAD_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLoadType(LoadTypeEnum loadType) { @@ -220,6 +229,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -250,6 +264,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information if available + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -275,6 +294,11 @@ public String getRecurringDetailReference() { } + /** + * recurringDetailReference + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -300,6 +324,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -325,6 +354,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -350,6 +384,11 @@ public String getShopperReference() { } + /** + * shopperReference + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -375,6 +414,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueLoadResponse.java b/src/main/java/com/adyen/model/storedvalue/StoredValueLoadResponse.java index a77b3f43c..1cce1a1a7 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueLoadResponse.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueLoadResponse.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -120,6 +119,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -145,6 +149,11 @@ public Amount getCurrentBalance() { } + /** + * currentBalance + * + * @param currentBalance + */ @JsonProperty(JSON_PROPERTY_CURRENT_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrentBalance(Amount currentBalance) { @@ -170,6 +179,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -195,6 +209,11 @@ public String getRefusalReason() { } + /** + * If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -220,6 +239,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field. * **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. * **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -245,6 +269,11 @@ public String getThirdPartyRefusalReason() { } + /** + * Raw refusal reason received from the third party, where available + * + * @param thirdPartyRefusalReason + */ @JsonProperty(JSON_PROPERTY_THIRD_PARTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThirdPartyRefusalReason(String thirdPartyRefusalReason) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeRequest.java b/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeRequest.java index 3a0ac0b36..e8c9d5968 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeRequest.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeRequest.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -170,6 +169,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -195,6 +199,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -225,6 +234,11 @@ public Map getPaymentMethod() { } + /** + * The collection that contains the type of the payment method and its specific information if available + * + * @param paymentMethod + */ @JsonProperty(JSON_PROPERTY_PAYMENT_METHOD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMethod(Map paymentMethod) { @@ -250,6 +264,11 @@ public String getRecurringDetailReference() { } + /** + * recurringDetailReference + * + * @param recurringDetailReference + */ @JsonProperty(JSON_PROPERTY_RECURRING_DETAIL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRecurringDetailReference(String recurringDetailReference) { @@ -275,6 +294,11 @@ public String getReference() { } + /** + * The reference to uniquely identify a payment. This reference is used in all communication with you about the payment status. We recommend using a unique value per payment; however, it is not a requirement. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -300,6 +324,11 @@ public ShopperInteractionEnum getShopperInteraction() { } + /** + * Specifies the sales channel, through which the shopper gives their card details, and whether the shopper is a returning customer. For the web service API, Adyen assumes Ecommerce shopper interaction by default. This field has the following possible values: * `Ecommerce` - Online transactions where the cardholder is present (online). For better authorisation rates, we recommend sending the card security code (CSC) along with the request. * `ContAuth` - Card on file and/or subscription transactions, where the cardholder is known to the merchant (returning customer). If the shopper is present (online), you can supply also the CSC to improve authorisation (one-click payment). * `Moto` - Mail-order and telephone-order transactions where the shopper is in contact with the merchant via email or telephone. * `POS` - Point-of-sale transactions where the shopper is physically present to make a payment using a secure payment terminal. + * + * @param shopperInteraction + */ @JsonProperty(JSON_PROPERTY_SHOPPER_INTERACTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperInteraction(ShopperInteractionEnum shopperInteraction) { @@ -325,6 +354,11 @@ public String getShopperReference() { } + /** + * shopperReference + * + * @param shopperReference + */ @JsonProperty(JSON_PROPERTY_SHOPPER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setShopperReference(String shopperReference) { @@ -350,6 +384,11 @@ public StatusEnum getStatus() { } + /** + * The status you want to change to + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -375,6 +414,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeResponse.java b/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeResponse.java index e4d91af3c..0a05e6977 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeResponse.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueStatusChangeResponse.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -120,6 +119,11 @@ public String getAuthCode() { } + /** + * Authorisation code: * When the payment is authorised, this field holds the authorisation code for the payment. * When the payment is not authorised, this field is empty. + * + * @param authCode + */ @JsonProperty(JSON_PROPERTY_AUTH_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAuthCode(String authCode) { @@ -145,6 +149,11 @@ public Amount getCurrentBalance() { } + /** + * currentBalance + * + * @param currentBalance + */ @JsonProperty(JSON_PROPERTY_CURRENT_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrentBalance(Amount currentBalance) { @@ -170,6 +179,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -195,6 +209,11 @@ public String getRefusalReason() { } + /** + * If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -220,6 +239,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field. * **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. * **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -245,6 +269,11 @@ public String getThirdPartyRefusalReason() { } + /** + * Raw refusal reason received from the third party, where available + * + * @param thirdPartyRefusalReason + */ @JsonProperty(JSON_PROPERTY_THIRD_PARTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThirdPartyRefusalReason(String thirdPartyRefusalReason) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueVoidRequest.java b/src/main/java/com/adyen/model/storedvalue/StoredValueVoidRequest.java index 84c8e9f93..b097e984b 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueVoidRequest.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueVoidRequest.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -80,6 +79,11 @@ public String getMerchantAccount() { } + /** + * The merchant account identifier, with which you want to process the transaction. + * + * @param merchantAccount + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantAccount(String merchantAccount) { @@ -105,6 +109,11 @@ public String getOriginalReference() { } + /** + * The original pspReference of the payment to modify. + * + * @param originalReference + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalReference(String originalReference) { @@ -130,6 +139,11 @@ public String getReference() { } + /** + * Your reference for the payment modification. This reference is visible in Customer Area and in reports. Maximum length: 80 characters. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -155,6 +169,11 @@ public String getStore() { } + /** + * The physical store, for which this payment is processed. + * + * @param store + */ @JsonProperty(JSON_PROPERTY_STORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStore(String store) { @@ -180,6 +199,11 @@ public String getTenderReference() { } + /** + * The reference of the tender. + * + * @param tenderReference + */ @JsonProperty(JSON_PROPERTY_TENDER_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTenderReference(String tenderReference) { @@ -205,6 +229,11 @@ public String getUniqueTerminalId() { } + /** + * The unique ID of a POS terminal. + * + * @param uniqueTerminalId + */ @JsonProperty(JSON_PROPERTY_UNIQUE_TERMINAL_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUniqueTerminalId(String uniqueTerminalId) { diff --git a/src/main/java/com/adyen/model/storedvalue/StoredValueVoidResponse.java b/src/main/java/com/adyen/model/storedvalue/StoredValueVoidResponse.java index 437d1817f..278ff799f 100644 --- a/src/main/java/com/adyen/model/storedvalue/StoredValueVoidResponse.java +++ b/src/main/java/com/adyen/model/storedvalue/StoredValueVoidResponse.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -116,6 +115,11 @@ public Amount getCurrentBalance() { } + /** + * currentBalance + * + * @param currentBalance + */ @JsonProperty(JSON_PROPERTY_CURRENT_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrentBalance(Amount currentBalance) { @@ -141,6 +145,11 @@ public String getPspReference() { } + /** + * Adyen's 16-character string reference associated with the transaction/request. This value is globally unique; quote it when communicating with us about this request. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -166,6 +175,11 @@ public String getRefusalReason() { } + /** + * If the transaction is refused or an error occurs, this field holds Adyen's mapped reason for the refusal or a description of the error. When a transaction fails, the authorisation response includes `resultCode` and `refusalReason` values. + * + * @param refusalReason + */ @JsonProperty(JSON_PROPERTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRefusalReason(String refusalReason) { @@ -191,6 +205,11 @@ public ResultCodeEnum getResultCode() { } + /** + * The result of the payment. Possible values: * **Success** – The operation has been completed successfully. * **Refused** – The operation was refused. The reason is given in the `refusalReason` field. * **Error** – There was an error when the operation was processed. The reason is given in the `refusalReason` field. * **NotEnoughBalance** – The amount on the payment method is lower than the amount given in the request. Only applicable to balance checks. + * + * @param resultCode + */ @JsonProperty(JSON_PROPERTY_RESULT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResultCode(ResultCodeEnum resultCode) { @@ -216,6 +235,11 @@ public String getThirdPartyRefusalReason() { } + /** + * Raw refusal reason received from the third party, where available + * + * @param thirdPartyRefusalReason + */ @JsonProperty(JSON_PROPERTY_THIRD_PARTY_REFUSAL_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThirdPartyRefusalReason(String thirdPartyRefusalReason) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/Amount.java b/src/main/java/com/adyen/model/transactionwebhooks/Amount.java index 69ae25d94..3f79b8400 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/Amount.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/BalancePlatformNotificationResponse.java b/src/main/java/com/adyen/model/transactionwebhooks/BalancePlatformNotificationResponse.java index b00fd7068..ceafe1f28 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/BalancePlatformNotificationResponse.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/BalancePlatformNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/Resource.java b/src/main/java/com/adyen/model/transactionwebhooks/Resource.java index 55e6e3fa3..025c913b8 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/Resource.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/Resource.java @@ -68,6 +68,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -93,6 +98,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/ResourceReference.java b/src/main/java/com/adyen/model/transactionwebhooks/ResourceReference.java index a336be0d9..ae90346ba 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/ResourceReference.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/ResourceReference.java @@ -67,6 +67,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -92,6 +97,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -117,6 +127,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/Transaction.java b/src/main/java/com/adyen/model/transactionwebhooks/Transaction.java index a17a6d514..b5a4b0b6a 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/Transaction.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/Transaction.java @@ -134,6 +134,11 @@ public ResourceReference getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(ResourceReference accountHolder) { @@ -159,6 +164,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -184,6 +194,11 @@ public ResourceReference getBalanceAccount() { } + /** + * balanceAccount + * + * @param balanceAccount + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccount(ResourceReference balanceAccount) { @@ -209,6 +224,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -234,6 +254,11 @@ public OffsetDateTime getBookingDate() { } + /** + * The date the transaction was booked into the balance account. + * + * @param bookingDate + */ @JsonProperty(JSON_PROPERTY_BOOKING_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBookingDate(OffsetDateTime bookingDate) { @@ -259,6 +284,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -284,6 +314,11 @@ public String getId() { } + /** + * The unique identifier of the transaction. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -309,6 +344,11 @@ public StatusEnum getStatus() { } + /** + * The status of the transaction. Possible values: * **pending**: The transaction is still pending. * **booked**: The transaction has been booked to the balance account. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -334,6 +374,11 @@ public TransferData getTransfer() { } + /** + * transfer + * + * @param transfer + */ @JsonProperty(JSON_PROPERTY_TRANSFER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransfer(TransferData transfer) { @@ -359,6 +404,11 @@ public OffsetDateTime getValueDate() { } + /** + * The date the transfer amount becomes available in the balance account. + * + * @param valueDate + */ @JsonProperty(JSON_PROPERTY_VALUE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValueDate(OffsetDateTime valueDate) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/TransactionNotificationRequestV4.java b/src/main/java/com/adyen/model/transactionwebhooks/TransactionNotificationRequestV4.java index f9058793d..4a686f818 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/TransactionNotificationRequestV4.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/TransactionNotificationRequestV4.java @@ -101,6 +101,11 @@ public Transaction getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(Transaction data) { @@ -126,6 +131,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -151,6 +161,11 @@ public TypeEnum getType() { } + /** + * Type of the webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transactionwebhooks/TransferData.java b/src/main/java/com/adyen/model/transactionwebhooks/TransferData.java index e138a083d..265e6e80d 100644 --- a/src/main/java/com/adyen/model/transactionwebhooks/TransferData.java +++ b/src/main/java/com/adyen/model/transactionwebhooks/TransferData.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getReference() { } + /** + * The [`reference`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_reference) from the `/transfers` request. If you haven't provided any, Adyen generates a unique reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transfers/AULocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/AULocalAccountIdentification.java index 0cbb906ec..e6a77e568 100644 --- a/src/main/java/com/adyen/model/transfers/AULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/AULocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBsbCode() { } + /** + * The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. + * + * @param bsbCode + */ @JsonProperty(JSON_PROPERTY_BSB_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBsbCode(String bsbCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **auLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/AdditionalBankIdentification.java b/src/main/java/com/adyen/model/transfers/AdditionalBankIdentification.java index e7cc6b7d1..27a6742ee 100644 --- a/src/main/java/com/adyen/model/transfers/AdditionalBankIdentification.java +++ b/src/main/java/com/adyen/model/transfers/AdditionalBankIdentification.java @@ -98,6 +98,11 @@ public String getCode() { } + /** + * The value of the additional bank identification. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * The type of additional bank identification, depending on the country. Possible values: * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/Address.java b/src/main/java/com/adyen/model/transfers/Address.java index 71f53a4fe..b1b0936d9 100644 --- a/src/main/java/com/adyen/model/transfers/Address.java +++ b/src/main/java/com/adyen/model/transfers/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO 3166-1 alpha-2 country code. For example, **US**, **NL**, or **GB**. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getLine1() { } + /** + * First line of the street address. + * + * @param line1 + */ @JsonProperty(JSON_PROPERTY_LINE1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine1(String line1) { @@ -154,6 +169,11 @@ public String getLine2() { } + /** + * Second line of the street address. + * + * @param line2 + */ @JsonProperty(JSON_PROPERTY_LINE2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine2(String line2) { @@ -179,6 +199,11 @@ public String getPostalCode() { } + /** + * The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -204,6 +229,11 @@ public String getStateOrProvince() { } + /** + * The two-letter ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { diff --git a/src/main/java/com/adyen/model/transfers/Amount.java b/src/main/java/com/adyen/model/transfers/Amount.java index 0f964c2f0..6f2845826 100644 --- a/src/main/java/com/adyen/model/transfers/Amount.java +++ b/src/main/java/com/adyen/model/transfers/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/transfers/BRLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/BRLocalAccountIdentification.java index 186367df8..b4752f52d 100644 --- a/src/main/java/com/adyen/model/transfers/BRLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/BRLocalAccountIdentification.java @@ -104,6 +104,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -129,6 +134,11 @@ public String getBankCode() { } + /** + * The 3-digit bank code, with leading zeros. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -154,6 +164,11 @@ public String getBranchNumber() { } + /** + * The bank account branch number, without separators or whitespace. + * + * @param branchNumber + */ @JsonProperty(JSON_PROPERTY_BRANCH_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBranchNumber(String branchNumber) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **brLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/BankAccountV3.java b/src/main/java/com/adyen/model/transfers/BankAccountV3.java index 7fedfd76a..bd50e49b0 100644 --- a/src/main/java/com/adyen/model/transfers/BankAccountV3.java +++ b/src/main/java/com/adyen/model/transfers/BankAccountV3.java @@ -65,6 +65,11 @@ public PartyIdentification getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(PartyIdentification accountHolder) { @@ -90,6 +95,11 @@ public BankAccountV3AccountIdentification getAccountIdentification() { } + /** + * accountIdentification + * + * @param accountIdentification + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountIdentification(BankAccountV3AccountIdentification accountIdentification) { diff --git a/src/main/java/com/adyen/model/transfers/BankCategoryData.java b/src/main/java/com/adyen/model/transfers/BankCategoryData.java index 0e6aa1179..382d1a62a 100644 --- a/src/main/java/com/adyen/model/transfers/BankCategoryData.java +++ b/src/main/java/com/adyen/model/transfers/BankCategoryData.java @@ -139,6 +139,11 @@ public PriorityEnum getPriority() { } + /** + * The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). + * + * @param priority + */ @JsonProperty(JSON_PROPERTY_PRIORITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriority(PriorityEnum priority) { @@ -164,6 +169,11 @@ public TypeEnum getType() { } + /** + * **bank** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/CALocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/CALocalAccountIdentification.java index b67d70737..a746eb636 100644 --- a/src/main/java/com/adyen/model/transfers/CALocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/CALocalAccountIdentification.java @@ -143,6 +143,11 @@ public String getAccountNumber() { } + /** + * The 5- to 12-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -168,6 +173,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -193,6 +203,11 @@ public String getInstitutionNumber() { } + /** + * The 3-digit institution number, without separators or whitespace. + * + * @param institutionNumber + */ @JsonProperty(JSON_PROPERTY_INSTITUTION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstitutionNumber(String institutionNumber) { @@ -218,6 +233,11 @@ public String getTransitNumber() { } + /** + * The 5-digit transit number, without separators or whitespace. + * + * @param transitNumber + */ @JsonProperty(JSON_PROPERTY_TRANSIT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransitNumber(String transitNumber) { @@ -243,6 +263,11 @@ public TypeEnum getType() { } + /** + * **caLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/CZLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/CZLocalAccountIdentification.java index f8ae32f48..dff6a8973 100644 --- a/src/main/java/com/adyen/model/transfers/CZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/CZLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Kód banky), without separators or whitespace. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **czLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/CapitalBalance.java b/src/main/java/com/adyen/model/transfers/CapitalBalance.java index 9e4aadfce..3f1f35eb0 100644 --- a/src/main/java/com/adyen/model/transfers/CapitalBalance.java +++ b/src/main/java/com/adyen/model/transfers/CapitalBalance.java @@ -71,6 +71,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -96,6 +101,11 @@ public Long getFee() { } + /** + * Fee amount. + * + * @param fee + */ @JsonProperty(JSON_PROPERTY_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFee(Long fee) { @@ -121,6 +131,11 @@ public Long getPrincipal() { } + /** + * Principal amount. + * + * @param principal + */ @JsonProperty(JSON_PROPERTY_PRINCIPAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrincipal(Long principal) { @@ -146,6 +161,11 @@ public Long getTotal() { } + /** + * Total amount. A sum of principal amount and fee amount. + * + * @param total + */ @JsonProperty(JSON_PROPERTY_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTotal(Long total) { diff --git a/src/main/java/com/adyen/model/transfers/CapitalGrant.java b/src/main/java/com/adyen/model/transfers/CapitalGrant.java index 9dcc6cbf0..14f5994c2 100644 --- a/src/main/java/com/adyen/model/transfers/CapitalGrant.java +++ b/src/main/java/com/adyen/model/transfers/CapitalGrant.java @@ -133,6 +133,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -158,6 +163,11 @@ public CapitalBalance getBalances() { } + /** + * balances + * + * @param balances + */ @JsonProperty(JSON_PROPERTY_BALANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalances(CapitalBalance balances) { @@ -183,6 +193,11 @@ public Counterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(Counterparty counterparty) { @@ -208,6 +223,11 @@ public Fee getFee() { } + /** + * fee + * + * @param fee + */ @JsonProperty(JSON_PROPERTY_FEE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFee(Fee fee) { @@ -233,6 +253,11 @@ public String getGrantAccountId() { } + /** + * The identifier of the grant account used for the grant. + * + * @param grantAccountId + */ @JsonProperty(JSON_PROPERTY_GRANT_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGrantAccountId(String grantAccountId) { @@ -258,6 +283,11 @@ public String getGrantOfferId() { } + /** + * The identifier of the grant offer that has been selected and from which the grant details will be used. + * + * @param grantOfferId + */ @JsonProperty(JSON_PROPERTY_GRANT_OFFER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGrantOfferId(String grantOfferId) { @@ -283,6 +313,11 @@ public String getId() { } + /** + * The identifier of the grant reference. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -308,6 +343,11 @@ public Repayment getRepayment() { } + /** + * repayment + * + * @param repayment + */ @JsonProperty(JSON_PROPERTY_REPAYMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRepayment(Repayment repayment) { @@ -333,6 +373,11 @@ public StatusEnum getStatus() { } + /** + * The current status of the grant. Possible values: **Pending**, **Active**, **Repaid**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/transfers/CapitalGrantInfo.java b/src/main/java/com/adyen/model/transfers/CapitalGrantInfo.java index 418ec5fd6..a032c5bf1 100644 --- a/src/main/java/com/adyen/model/transfers/CapitalGrantInfo.java +++ b/src/main/java/com/adyen/model/transfers/CapitalGrantInfo.java @@ -68,6 +68,11 @@ public Counterparty getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(Counterparty counterparty) { @@ -93,6 +98,11 @@ public String getGrantAccountId() { } + /** + * The identifier of the grant account used for the grant. + * + * @param grantAccountId + */ @JsonProperty(JSON_PROPERTY_GRANT_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGrantAccountId(String grantAccountId) { @@ -118,6 +128,11 @@ public String getGrantOfferId() { } + /** + * The identifier of the grant offer that has been selected and from which the grant details will be used. + * + * @param grantOfferId + */ @JsonProperty(JSON_PROPERTY_GRANT_OFFER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGrantOfferId(String grantOfferId) { diff --git a/src/main/java/com/adyen/model/transfers/CapitalGrants.java b/src/main/java/com/adyen/model/transfers/CapitalGrants.java index 9c7b50229..0e13b9c95 100644 --- a/src/main/java/com/adyen/model/transfers/CapitalGrants.java +++ b/src/main/java/com/adyen/model/transfers/CapitalGrants.java @@ -67,6 +67,11 @@ public List getGrants() { } + /** + * The unique identifier of the grant. + * + * @param grants + */ @JsonProperty(JSON_PROPERTY_GRANTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setGrants(List grants) { diff --git a/src/main/java/com/adyen/model/transfers/Counterparty.java b/src/main/java/com/adyen/model/transfers/Counterparty.java index ba1aca0a4..b1b520224 100644 --- a/src/main/java/com/adyen/model/transfers/Counterparty.java +++ b/src/main/java/com/adyen/model/transfers/Counterparty.java @@ -67,6 +67,11 @@ public String getAccountHolderId() { } + /** + * The identifier of the receiving account holder. The payout will default to the primary balance account of this account holder if no `balanceAccountId` is provided. + * + * @param accountHolderId + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolderId(String accountHolderId) { @@ -92,6 +97,11 @@ public String getBalanceAccountId() { } + /** + * The identifier of the balance account that belongs to the receiving account holder. + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -117,6 +127,11 @@ public String getTransferInstrumentId() { } + /** + * The identifier of the transfer instrument that belongs to the legal entity of the account holder. + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/transfers/CounterpartyInfoV3.java b/src/main/java/com/adyen/model/transfers/CounterpartyInfoV3.java index edcf5f9b1..eece1f101 100644 --- a/src/main/java/com/adyen/model/transfers/CounterpartyInfoV3.java +++ b/src/main/java/com/adyen/model/transfers/CounterpartyInfoV3.java @@ -68,6 +68,11 @@ public String getBalanceAccountId() { } + /** + * Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -93,6 +98,11 @@ public BankAccountV3 getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccountV3 bankAccount) { @@ -118,6 +128,11 @@ public String getTransferInstrumentId() { } + /** + * Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/transfers/CounterpartyV3.java b/src/main/java/com/adyen/model/transfers/CounterpartyV3.java index 56446f3c9..69bb54539 100644 --- a/src/main/java/com/adyen/model/transfers/CounterpartyV3.java +++ b/src/main/java/com/adyen/model/transfers/CounterpartyV3.java @@ -73,6 +73,11 @@ public String getBalanceAccountId() { } + /** + * Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -98,6 +103,11 @@ public BankAccountV3 getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccountV3 bankAccount) { @@ -123,6 +133,11 @@ public MerchantData getMerchant() { } + /** + * merchant + * + * @param merchant + */ @JsonProperty(JSON_PROPERTY_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchant(MerchantData merchant) { @@ -148,6 +163,11 @@ public String getTransferInstrumentId() { } + /** + * Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/transfers/DKLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/DKLocalAccountIdentification.java index d02a1d9a2..4296c54d7 100644 --- a/src/main/java/com/adyen/model/transfers/DKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/DKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Registreringsnummer) (without separators or whitespace). + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **dkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/Fee.java b/src/main/java/com/adyen/model/transfers/Fee.java index 9eb41a69f..a4ba4f1bd 100644 --- a/src/main/java/com/adyen/model/transfers/Fee.java +++ b/src/main/java/com/adyen/model/transfers/Fee.java @@ -60,6 +60,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { diff --git a/src/main/java/com/adyen/model/transfers/HKLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/HKLocalAccountIdentification.java index 5ad9af724..d3c2dcb93 100644 --- a/src/main/java/com/adyen/model/transfers/HKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/HKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingCode() { } + /** + * The 3-digit clearing code, without separators or whitespace. + * + * @param clearingCode + */ @JsonProperty(JSON_PROPERTY_CLEARING_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingCode(String clearingCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **hkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/HULocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/HULocalAccountIdentification.java index 853ae0dca..08c631376 100644 --- a/src/main/java/com/adyen/model/transfers/HULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/HULocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 24-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **huLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/IbanAccountIdentification.java b/src/main/java/com/adyen/model/transfers/IbanAccountIdentification.java index 903908e67..7fecdb916 100644 --- a/src/main/java/com/adyen/model/transfers/IbanAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/IbanAccountIdentification.java @@ -96,6 +96,11 @@ public String getIban() { } + /** + * The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **iban** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/InternalCategoryData.java b/src/main/java/com/adyen/model/transfers/InternalCategoryData.java index 50ee37e61..4efa3d6d7 100644 --- a/src/main/java/com/adyen/model/transfers/InternalCategoryData.java +++ b/src/main/java/com/adyen/model/transfers/InternalCategoryData.java @@ -100,6 +100,11 @@ public String getModificationMerchantReference() { } + /** + * The capture's merchant reference included in the transfer. + * + * @param modificationMerchantReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationMerchantReference(String modificationMerchantReference) { @@ -125,6 +130,11 @@ public String getModificationPspReference() { } + /** + * The capture reference included in the transfer. + * + * @param modificationPspReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationPspReference(String modificationPspReference) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **internal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/InvalidField.java b/src/main/java/com/adyen/model/transfers/InvalidField.java index 5ce85df45..320c3adc4 100644 --- a/src/main/java/com/adyen/model/transfers/InvalidField.java +++ b/src/main/java/com/adyen/model/transfers/InvalidField.java @@ -67,6 +67,11 @@ public String getMessage() { } + /** + * Description of the validation error. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -92,6 +97,11 @@ public String getName() { } + /** + * The field that has an invalid value. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -117,6 +127,11 @@ public String getValue() { } + /** + * The invalid value. + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(String value) { diff --git a/src/main/java/com/adyen/model/transfers/IssuedCard.java b/src/main/java/com/adyen/model/transfers/IssuedCard.java index a21209a60..82f7e884d 100644 --- a/src/main/java/com/adyen/model/transfers/IssuedCard.java +++ b/src/main/java/com/adyen/model/transfers/IssuedCard.java @@ -35,14 +35,20 @@ * IssuedCard */ @JsonPropertyOrder({ + IssuedCard.JSON_PROPERTY_AUTHORISATION_TYPE, IssuedCard.JSON_PROPERTY_PAN_ENTRY_MODE, IssuedCard.JSON_PROPERTY_PROCESSING_TYPE, IssuedCard.JSON_PROPERTY_RELAYED_AUTHORISATION_DATA, + IssuedCard.JSON_PROPERTY_SCHEME_TRACE_ID, + IssuedCard.JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID, IssuedCard.JSON_PROPERTY_TYPE, IssuedCard.JSON_PROPERTY_VALIDATION_FACTS }) public class IssuedCard { + public static final String JSON_PROPERTY_AUTHORISATION_TYPE = "authorisationType"; + private String authorisationType; + /** * Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**. */ @@ -144,6 +150,12 @@ public static ProcessingTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_RELAYED_AUTHORISATION_DATA = "relayedAuthorisationData"; private RelayedAuthorisationData relayedAuthorisationData; + public static final String JSON_PROPERTY_SCHEME_TRACE_ID = "schemeTraceId"; + private String schemeTraceId; + + public static final String JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID = "schemeUniqueTransactionId"; + private String schemeUniqueTransactionId; + /** * **issuedCard** */ @@ -186,6 +198,36 @@ public static TypeEnum fromValue(String value) { public IssuedCard() { } + public IssuedCard authorisationType(String authorisationType) { + this.authorisationType = authorisationType; + return this; + } + + /** + * The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation** + * @return authorisationType + **/ + @ApiModelProperty(value = "The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation**") + @JsonProperty(JSON_PROPERTY_AUTHORISATION_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getAuthorisationType() { + return authorisationType; + } + + + /** + * The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation** + * + * @param authorisationType + */ + @JsonProperty(JSON_PROPERTY_AUTHORISATION_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAuthorisationType(String authorisationType) { + this.authorisationType = authorisationType; + } + + public IssuedCard panEntryMode(PanEntryModeEnum panEntryMode) { this.panEntryMode = panEntryMode; return this; @@ -204,6 +246,11 @@ public PanEntryModeEnum getPanEntryMode() { } + /** + * Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**. + * + * @param panEntryMode + */ @JsonProperty(JSON_PROPERTY_PAN_ENTRY_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPanEntryMode(PanEntryModeEnum panEntryMode) { @@ -229,6 +276,11 @@ public ProcessingTypeEnum getProcessingType() { } + /** + * Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for in-person payments. + * + * @param processingType + */ @JsonProperty(JSON_PROPERTY_PROCESSING_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProcessingType(ProcessingTypeEnum processingType) { @@ -254,6 +306,11 @@ public RelayedAuthorisationData getRelayedAuthorisationData() { } + /** + * relayedAuthorisationData + * + * @param relayedAuthorisationData + */ @JsonProperty(JSON_PROPERTY_RELAYED_AUTHORISATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRelayedAuthorisationData(RelayedAuthorisationData relayedAuthorisationData) { @@ -261,6 +318,66 @@ public void setRelayedAuthorisationData(RelayedAuthorisationData relayedAuthoris } + public IssuedCard schemeTraceId(String schemeTraceId) { + this.schemeTraceId = schemeTraceId; + return this; + } + + /** + * The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments. + * @return schemeTraceId + **/ + @ApiModelProperty(value = "The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments.") + @JsonProperty(JSON_PROPERTY_SCHEME_TRACE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSchemeTraceId() { + return schemeTraceId; + } + + + /** + * The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments. + * + * @param schemeTraceId + */ + @JsonProperty(JSON_PROPERTY_SCHEME_TRACE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSchemeTraceId(String schemeTraceId) { + this.schemeTraceId = schemeTraceId; + } + + + public IssuedCard schemeUniqueTransactionId(String schemeUniqueTransactionId) { + this.schemeUniqueTransactionId = schemeUniqueTransactionId; + return this; + } + + /** + * The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme. + * @return schemeUniqueTransactionId + **/ + @ApiModelProperty(value = "The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme.") + @JsonProperty(JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSchemeUniqueTransactionId() { + return schemeUniqueTransactionId; + } + + + /** + * The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme. + * + * @param schemeUniqueTransactionId + */ + @JsonProperty(JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSchemeUniqueTransactionId(String schemeUniqueTransactionId) { + this.schemeUniqueTransactionId = schemeUniqueTransactionId; + } + + public IssuedCard type(TypeEnum type) { this.type = type; return this; @@ -279,6 +396,11 @@ public TypeEnum getType() { } + /** + * **issuedCard** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -312,6 +434,11 @@ public List getValidationFacts() { } + /** + * The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks) for more information. + * + * @param validationFacts + */ @JsonProperty(JSON_PROPERTY_VALIDATION_FACTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidationFacts(List validationFacts) { @@ -331,25 +458,31 @@ public boolean equals(Object o) { return false; } IssuedCard issuedCard = (IssuedCard) o; - return Objects.equals(this.panEntryMode, issuedCard.panEntryMode) && + return Objects.equals(this.authorisationType, issuedCard.authorisationType) && + Objects.equals(this.panEntryMode, issuedCard.panEntryMode) && Objects.equals(this.processingType, issuedCard.processingType) && Objects.equals(this.relayedAuthorisationData, issuedCard.relayedAuthorisationData) && + Objects.equals(this.schemeTraceId, issuedCard.schemeTraceId) && + Objects.equals(this.schemeUniqueTransactionId, issuedCard.schemeUniqueTransactionId) && Objects.equals(this.type, issuedCard.type) && Objects.equals(this.validationFacts, issuedCard.validationFacts); } @Override public int hashCode() { - return Objects.hash(panEntryMode, processingType, relayedAuthorisationData, type, validationFacts); + return Objects.hash(authorisationType, panEntryMode, processingType, relayedAuthorisationData, schemeTraceId, schemeUniqueTransactionId, type, validationFacts); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class IssuedCard {\n"); + sb.append(" authorisationType: ").append(toIndentedString(authorisationType)).append("\n"); sb.append(" panEntryMode: ").append(toIndentedString(panEntryMode)).append("\n"); sb.append(" processingType: ").append(toIndentedString(processingType)).append("\n"); sb.append(" relayedAuthorisationData: ").append(toIndentedString(relayedAuthorisationData)).append("\n"); + sb.append(" schemeTraceId: ").append(toIndentedString(schemeTraceId)).append("\n"); + sb.append(" schemeUniqueTransactionId: ").append(toIndentedString(schemeUniqueTransactionId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" validationFacts: ").append(toIndentedString(validationFacts)).append("\n"); sb.append("}"); diff --git a/src/main/java/com/adyen/model/transfers/Link.java b/src/main/java/com/adyen/model/transfers/Link.java index 225af449d..01704ab08 100644 --- a/src/main/java/com/adyen/model/transfers/Link.java +++ b/src/main/java/com/adyen/model/transfers/Link.java @@ -59,6 +59,11 @@ public String getHref() { } + /** + * href + * + * @param href + */ @JsonProperty(JSON_PROPERTY_HREF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setHref(String href) { diff --git a/src/main/java/com/adyen/model/transfers/Links.java b/src/main/java/com/adyen/model/transfers/Links.java index 9d56f3823..8716ea05f 100644 --- a/src/main/java/com/adyen/model/transfers/Links.java +++ b/src/main/java/com/adyen/model/transfers/Links.java @@ -64,6 +64,11 @@ public Link getNext() { } + /** + * next + * + * @param next + */ @JsonProperty(JSON_PROPERTY_NEXT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNext(Link next) { @@ -89,6 +94,11 @@ public Link getPrev() { } + /** + * prev + * + * @param prev + */ @JsonProperty(JSON_PROPERTY_PREV) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPrev(Link prev) { diff --git a/src/main/java/com/adyen/model/transfers/MerchantData.java b/src/main/java/com/adyen/model/transfers/MerchantData.java index 32777b0ba..fa91b7ad3 100644 --- a/src/main/java/com/adyen/model/transfers/MerchantData.java +++ b/src/main/java/com/adyen/model/transfers/MerchantData.java @@ -76,6 +76,11 @@ public String getAcquirerId() { } + /** + * The unique identifier of the merchant's acquirer. + * + * @param acquirerId + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerId(String acquirerId) { @@ -101,6 +106,11 @@ public String getMcc() { } + /** + * The merchant category code. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -126,6 +136,11 @@ public String getMerchantId() { } + /** + * The merchant identifier. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -151,6 +166,11 @@ public NameLocation getNameLocation() { } + /** + * nameLocation + * + * @param nameLocation + */ @JsonProperty(JSON_PROPERTY_NAME_LOCATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNameLocation(NameLocation nameLocation) { @@ -176,6 +196,11 @@ public String getPostalCode() { } + /** + * The merchant postal code. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { diff --git a/src/main/java/com/adyen/model/transfers/NOLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/NOLocalAccountIdentification.java index c639fddee..8f0f14f48 100644 --- a/src/main/java/com/adyen/model/transfers/NOLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/NOLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 11-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **noLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/NZLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/NZLocalAccountIdentification.java index 440656f3c..b97889e5e 100644 --- a/src/main/java/com/adyen/model/transfers/NZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/NZLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **nzLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/NameLocation.java b/src/main/java/com/adyen/model/transfers/NameLocation.java index 9cde56140..e71656d5b 100644 --- a/src/main/java/com/adyen/model/transfers/NameLocation.java +++ b/src/main/java/com/adyen/model/transfers/NameLocation.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The city where the merchant is located. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The country where the merchant is located in [three-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getCountryOfOrigin() { } + /** + * The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) format, used for government-controlled merchants such as embassies. + * + * @param countryOfOrigin + */ @JsonProperty(JSON_PROPERTY_COUNTRY_OF_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryOfOrigin(String countryOfOrigin) { @@ -154,6 +169,11 @@ public String getName() { } + /** + * The name of the merchant's shop or service. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -179,6 +199,11 @@ public String getRawData() { } + /** + * The raw data. + * + * @param rawData + */ @JsonProperty(JSON_PROPERTY_RAW_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRawData(String rawData) { @@ -204,6 +229,11 @@ public String getState() { } + /** + * The state where the merchant is located. + * + * @param state + */ @JsonProperty(JSON_PROPERTY_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setState(String state) { diff --git a/src/main/java/com/adyen/model/transfers/NumberAndBicAccountIdentification.java b/src/main/java/com/adyen/model/transfers/NumberAndBicAccountIdentification.java index 050e7f52a..f8cfbef97 100644 --- a/src/main/java/com/adyen/model/transfers/NumberAndBicAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/NumberAndBicAccountIdentification.java @@ -105,6 +105,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. The length and format depends on the bank or country. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -130,6 +135,11 @@ public AdditionalBankIdentification getAdditionalBankIdentification() { } + /** + * additionalBankIdentification + * + * @param additionalBankIdentification + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_BANK_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalBankIdentification(AdditionalBankIdentification additionalBankIdentification) { @@ -155,6 +165,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -180,6 +195,11 @@ public TypeEnum getType() { } + /** + * **numberAndBic** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/PLLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/PLLocalAccountIdentification.java index 996944c5a..d33360d91 100644 --- a/src/main/java/com/adyen/model/transfers/PLLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/PLLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **plLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/PartyIdentification.java b/src/main/java/com/adyen/model/transfers/PartyIdentification.java index 1c26c1be9..71651aa83 100644 --- a/src/main/java/com/adyen/model/transfers/PartyIdentification.java +++ b/src/main/java/com/adyen/model/transfers/PartyIdentification.java @@ -122,6 +122,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -147,6 +152,11 @@ public LocalDate getDateOfBirth() { } + /** + * The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Should not be before January 1, 1900. Allowed only when `type` is **individual**. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -172,6 +182,11 @@ public String getFirstName() { } + /** + * First name of the individual. Allowed only when `type` is **individual**. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -197,6 +212,11 @@ public String getFullName() { } + /** + * The name of the entity. + * + * @param fullName + */ @JsonProperty(JSON_PROPERTY_FULL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFullName(String fullName) { @@ -222,6 +242,11 @@ public String getLastName() { } + /** + * Last name of the individual. Allowed only when `type` is **individual**. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -247,6 +272,11 @@ public String getReference() { } + /** + * A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -272,6 +302,11 @@ public TypeEnum getType() { } + /** + * The type of entity that owns the bank account. Possible values: **individual**, **organization**, or **unknown**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/PaymentInstrument.java b/src/main/java/com/adyen/model/transfers/PaymentInstrument.java index 7d048cde6..b59bef541 100644 --- a/src/main/java/com/adyen/model/transfers/PaymentInstrument.java +++ b/src/main/java/com/adyen/model/transfers/PaymentInstrument.java @@ -71,6 +71,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -96,6 +101,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -121,6 +131,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -146,6 +161,11 @@ public String getTokenType() { } + /** + * The type of wallet the network token is associated with. + * + * @param tokenType + */ @JsonProperty(JSON_PROPERTY_TOKEN_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenType(String tokenType) { diff --git a/src/main/java/com/adyen/model/transfers/PlatformPayment.java b/src/main/java/com/adyen/model/transfers/PlatformPayment.java index 7a5c907d1..9e78a6bb9 100644 --- a/src/main/java/com/adyen/model/transfers/PlatformPayment.java +++ b/src/main/java/com/adyen/model/transfers/PlatformPayment.java @@ -169,6 +169,11 @@ public String getModificationMerchantReference() { } + /** + * The capture's merchant reference included in the transfer. + * + * @param modificationMerchantReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationMerchantReference(String modificationMerchantReference) { @@ -194,6 +199,11 @@ public String getModificationPspReference() { } + /** + * The capture reference included in the transfer. + * + * @param modificationPspReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationPspReference(String modificationPspReference) { @@ -219,6 +229,11 @@ public String getPaymentMerchantReference() { } + /** + * The payment's merchant reference included in the transfer. + * + * @param paymentMerchantReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMerchantReference(String paymentMerchantReference) { @@ -244,6 +259,11 @@ public PlatformPaymentTypeEnum getPlatformPaymentType() { } + /** + * The type of the related split. + * + * @param platformPaymentType + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentType(PlatformPaymentTypeEnum platformPaymentType) { @@ -269,6 +289,11 @@ public String getPspPaymentReference() { } + /** + * The payment reference included in the transfer. + * + * @param pspPaymentReference + */ @JsonProperty(JSON_PROPERTY_PSP_PAYMENT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspPaymentReference(String pspPaymentReference) { @@ -294,6 +319,11 @@ public TypeEnum getType() { } + /** + * **platformPayment** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/RelayedAuthorisationData.java b/src/main/java/com/adyen/model/transfers/RelayedAuthorisationData.java index 4b2332bae..a1839f7b4 100644 --- a/src/main/java/com/adyen/model/transfers/RelayedAuthorisationData.java +++ b/src/main/java/com/adyen/model/transfers/RelayedAuthorisationData.java @@ -74,6 +74,11 @@ public Map getMetadata() { } + /** + * Contains key-value pairs of your references and descriptions, for example, `customId`:`your-own-custom-field-12345`. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -99,6 +104,11 @@ public String getReference() { } + /** + * Your reference for the relayed authorisation data. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transfers/Repayment.java b/src/main/java/com/adyen/model/transfers/Repayment.java index 6b9a69ef0..8431db3cc 100644 --- a/src/main/java/com/adyen/model/transfers/Repayment.java +++ b/src/main/java/com/adyen/model/transfers/Repayment.java @@ -69,6 +69,11 @@ public Integer getBasisPoints() { } + /** + * The repayment that is deducted daily from incoming net volume, in [basis points](https://www.investopedia.com/terms/b/basispoint.asp). + * + * @param basisPoints + */ @JsonProperty(JSON_PROPERTY_BASIS_POINTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBasisPoints(Integer basisPoints) { @@ -94,6 +99,11 @@ public RepaymentTerm getTerm() { } + /** + * term + * + * @param term + */ @JsonProperty(JSON_PROPERTY_TERM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTerm(RepaymentTerm term) { @@ -119,6 +129,11 @@ public ThresholdRepayment getThreshold() { } + /** + * threshold + * + * @param threshold + */ @JsonProperty(JSON_PROPERTY_THRESHOLD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setThreshold(ThresholdRepayment threshold) { diff --git a/src/main/java/com/adyen/model/transfers/RepaymentTerm.java b/src/main/java/com/adyen/model/transfers/RepaymentTerm.java index fcdd2bb88..d14b93921 100644 --- a/src/main/java/com/adyen/model/transfers/RepaymentTerm.java +++ b/src/main/java/com/adyen/model/transfers/RepaymentTerm.java @@ -63,6 +63,11 @@ public Integer getEstimatedDays() { } + /** + * The estimated term for repaying the grant, in days. + * + * @param estimatedDays + */ @JsonProperty(JSON_PROPERTY_ESTIMATED_DAYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEstimatedDays(Integer estimatedDays) { @@ -88,6 +93,11 @@ public Integer getMaximumDays() { } + /** + * The maximum term for repaying the grant, in days. Only applies when `contractType` is **loan**. + * + * @param maximumDays + */ @JsonProperty(JSON_PROPERTY_MAXIMUM_DAYS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMaximumDays(Integer maximumDays) { diff --git a/src/main/java/com/adyen/model/transfers/ResourceReference.java b/src/main/java/com/adyen/model/transfers/ResourceReference.java index a52333f9b..b7fac8687 100644 --- a/src/main/java/com/adyen/model/transfers/ResourceReference.java +++ b/src/main/java/com/adyen/model/transfers/ResourceReference.java @@ -67,6 +67,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -92,6 +97,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -117,6 +127,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transfers/RestServiceError.java b/src/main/java/com/adyen/model/transfers/RestServiceError.java index 6506825be..1272773f0 100644 --- a/src/main/java/com/adyen/model/transfers/RestServiceError.java +++ b/src/main/java/com/adyen/model/transfers/RestServiceError.java @@ -94,6 +94,11 @@ public String getDetail() { } + /** + * A human-readable explanation specific to this occurrence of the problem. + * + * @param detail + */ @JsonProperty(JSON_PROPERTY_DETAIL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDetail(String detail) { @@ -119,6 +124,11 @@ public String getErrorCode() { } + /** + * A code that identifies the problem type. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -144,6 +154,11 @@ public String getInstance() { } + /** + * A unique URI that identifies the specific occurrence of the problem. + * + * @param instance + */ @JsonProperty(JSON_PROPERTY_INSTANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstance(String instance) { @@ -177,6 +192,11 @@ public List getInvalidFields() { } + /** + * Detailed explanation of each validation error, when applicable. + * + * @param invalidFields + */ @JsonProperty(JSON_PROPERTY_INVALID_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInvalidFields(List invalidFields) { @@ -202,6 +222,11 @@ public String getRequestId() { } + /** + * A unique reference for the request, essentially the same as `pspReference`. + * + * @param requestId + */ @JsonProperty(JSON_PROPERTY_REQUEST_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRequestId(String requestId) { @@ -215,10 +240,10 @@ public RestServiceError response(Object response) { } /** - * JSON response payload. + * Get response * @return response **/ - @ApiModelProperty(value = "JSON response payload.") + @ApiModelProperty(value = "") @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -227,6 +252,11 @@ public Object getResponse() { } + /** + * response + * + * @param response + */ @JsonProperty(JSON_PROPERTY_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResponse(Object response) { @@ -252,6 +282,11 @@ public Integer getStatus() { } + /** + * The HTTP status code. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { @@ -277,6 +312,11 @@ public String getTitle() { } + /** + * A short, human-readable summary of the problem type. + * + * @param title + */ @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTitle(String title) { @@ -302,6 +342,11 @@ public String getType() { } + /** + * A URI that identifies the problem type, pointing to human-readable documentation on this problem type. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/transfers/ReturnTransferRequest.java b/src/main/java/com/adyen/model/transfers/ReturnTransferRequest.java index 08695c039..04137768f 100644 --- a/src/main/java/com/adyen/model/transfers/ReturnTransferRequest.java +++ b/src/main/java/com/adyen/model/transfers/ReturnTransferRequest.java @@ -64,6 +64,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -89,6 +94,11 @@ public String getReference() { } + /** + * Your internal reference for the return. If you don't provide this in the request, Adyen generates a unique reference. This reference is used in all communication with you about the instruction status. We recommend using a unique value per instruction. If you need to provide multiple references for a transaction, separate them with hyphens (\"-\"). + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transfers/ReturnTransferResponse.java b/src/main/java/com/adyen/model/transfers/ReturnTransferResponse.java index 12a6451f5..b4bbfdb2e 100644 --- a/src/main/java/com/adyen/model/transfers/ReturnTransferResponse.java +++ b/src/main/java/com/adyen/model/transfers/ReturnTransferResponse.java @@ -45,7 +45,7 @@ public class ReturnTransferResponse { private String reference; /** - * The resulting status of the return. For example: **authorised**, **booked**, **error**. + * The resulting status of the return. Possible values: **Authorised**, **Declined**. */ public enum StatusEnum { AUTHORISED("Authorised"), @@ -106,6 +106,11 @@ public String getId() { } + /** + * The unique identifier of the return. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -131,6 +136,11 @@ public String getReference() { } + /** + * Your internal reference for the return. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -144,10 +154,10 @@ public ReturnTransferResponse status(StatusEnum status) { } /** - * The resulting status of the return. For example: **authorised**, **booked**, **error**. + * The resulting status of the return. Possible values: **Authorised**, **Declined**. * @return status **/ - @ApiModelProperty(value = "The resulting status of the return. For example: **authorised**, **booked**, **error**.") + @ApiModelProperty(value = "The resulting status of the return. Possible values: **Authorised**, **Declined**.") @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) @@ -156,6 +166,11 @@ public StatusEnum getStatus() { } + /** + * The resulting status of the return. Possible values: **Authorised**, **Declined**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -181,6 +196,11 @@ public String getTransferId() { } + /** + * The unique identifier of the original transfer. + * + * @param transferId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferId(String transferId) { diff --git a/src/main/java/com/adyen/model/transfers/SELocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/SELocalAccountIdentification.java index 237bd80af..b53a14dbb 100644 --- a/src/main/java/com/adyen/model/transfers/SELocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/SELocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingNumber() { } + /** + * The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. + * + * @param clearingNumber + */ @JsonProperty(JSON_PROPERTY_CLEARING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingNumber(String clearingNumber) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **seLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/SGLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/SGLocalAccountIdentification.java index db1d1e5a1..308d57f5f 100644 --- a/src/main/java/com/adyen/model/transfers/SGLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/SGLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4- to 19-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **sgLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/ServiceError.java b/src/main/java/com/adyen/model/transfers/ServiceError.java index ee7ff68e8..e69f22424 100644 --- a/src/main/java/com/adyen/model/transfers/ServiceError.java +++ b/src/main/java/com/adyen/model/transfers/ServiceError.java @@ -75,6 +75,11 @@ public String getErrorCode() { } + /** + * The error code mapped to the error message. + * + * @param errorCode + */ @JsonProperty(JSON_PROPERTY_ERROR_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorCode(String errorCode) { @@ -100,6 +105,11 @@ public String getErrorType() { } + /** + * The category of the error. + * + * @param errorType + */ @JsonProperty(JSON_PROPERTY_ERROR_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setErrorType(String errorType) { @@ -125,6 +135,11 @@ public String getMessage() { } + /** + * A short explanation of the issue. + * + * @param message + */ @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMessage(String message) { @@ -150,6 +165,11 @@ public String getPspReference() { } + /** + * The PSP reference of the payment. + * + * @param pspReference + */ @JsonProperty(JSON_PROPERTY_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspReference(String pspReference) { @@ -175,6 +195,11 @@ public Integer getStatus() { } + /** + * The HTTP response status. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(Integer status) { diff --git a/src/main/java/com/adyen/model/transfers/ThresholdRepayment.java b/src/main/java/com/adyen/model/transfers/ThresholdRepayment.java index fc77bf7f4..2eaa83971 100644 --- a/src/main/java/com/adyen/model/transfers/ThresholdRepayment.java +++ b/src/main/java/com/adyen/model/transfers/ThresholdRepayment.java @@ -60,6 +60,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { diff --git a/src/main/java/com/adyen/model/transfers/Transaction.java b/src/main/java/com/adyen/model/transfers/Transaction.java index 0e3a759c0..bdb88b794 100644 --- a/src/main/java/com/adyen/model/transfers/Transaction.java +++ b/src/main/java/com/adyen/model/transfers/Transaction.java @@ -134,6 +134,11 @@ public ResourceReference getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(ResourceReference accountHolder) { @@ -159,6 +164,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -184,6 +194,11 @@ public ResourceReference getBalanceAccount() { } + /** + * balanceAccount + * + * @param balanceAccount + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccount(ResourceReference balanceAccount) { @@ -209,6 +224,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -234,6 +254,11 @@ public OffsetDateTime getBookingDate() { } + /** + * The date the transaction was booked into the balance account. + * + * @param bookingDate + */ @JsonProperty(JSON_PROPERTY_BOOKING_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBookingDate(OffsetDateTime bookingDate) { @@ -259,6 +284,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -284,6 +314,11 @@ public String getId() { } + /** + * The unique identifier of the transaction. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -309,6 +344,11 @@ public StatusEnum getStatus() { } + /** + * The status of the transaction. Possible values: * **pending**: The transaction is still pending. * **booked**: The transaction has been booked to the balance account. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -334,6 +374,11 @@ public TransferData getTransfer() { } + /** + * transfer + * + * @param transfer + */ @JsonProperty(JSON_PROPERTY_TRANSFER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransfer(TransferData transfer) { @@ -359,6 +404,11 @@ public OffsetDateTime getValueDate() { } + /** + * The date the transfer amount becomes available in the balance account. + * + * @param valueDate + */ @JsonProperty(JSON_PROPERTY_VALUE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValueDate(OffsetDateTime valueDate) { diff --git a/src/main/java/com/adyen/model/transfers/TransactionSearchResponse.java b/src/main/java/com/adyen/model/transfers/TransactionSearchResponse.java index a71ec380f..b48c0d041 100644 --- a/src/main/java/com/adyen/model/transfers/TransactionSearchResponse.java +++ b/src/main/java/com/adyen/model/transfers/TransactionSearchResponse.java @@ -67,6 +67,11 @@ public Links getLinks() { } + /** + * links + * + * @param links + */ @JsonProperty(JSON_PROPERTY_LINKS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLinks(Links links) { @@ -100,6 +105,11 @@ public List getData() { } + /** + * Contains the transactions that match the query parameters. + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(List data) { diff --git a/src/main/java/com/adyen/model/transfers/Transfer.java b/src/main/java/com/adyen/model/transfers/Transfer.java index ca498a027..a83e6c34f 100644 --- a/src/main/java/com/adyen/model/transfers/Transfer.java +++ b/src/main/java/com/adyen/model/transfers/Transfer.java @@ -417,6 +417,11 @@ public ResourceReference getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(ResourceReference accountHolder) { @@ -442,6 +447,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -467,6 +477,11 @@ public ResourceReference getBalanceAccount() { } + /** + * balanceAccount + * + * @param balanceAccount + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccount(ResourceReference balanceAccount) { @@ -492,6 +507,11 @@ public CategoryEnum getCategory() { } + /** + * The category of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -517,6 +537,11 @@ public TransferCategoryData getCategoryData() { } + /** + * categoryData + * + * @param categoryData + */ @JsonProperty(JSON_PROPERTY_CATEGORY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategoryData(TransferCategoryData categoryData) { @@ -542,6 +567,11 @@ public CounterpartyV3 getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(CounterpartyV3 counterparty) { @@ -567,6 +597,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -592,6 +627,11 @@ public String getDescription() { } + /** + * Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?** + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -617,6 +657,11 @@ public DirectionEnum getDirection() { } + /** + * The direction of the transfer. Possible values: **incoming**, **outgoing**. + * + * @param direction + */ @JsonProperty(JSON_PROPERTY_DIRECTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirection(DirectionEnum direction) { @@ -642,6 +687,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -667,6 +717,11 @@ public PaymentInstrument getPaymentInstrument() { } + /** + * paymentInstrument + * + * @param paymentInstrument + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrument(PaymentInstrument paymentInstrument) { @@ -692,6 +747,11 @@ public ReasonEnum getReason() { } + /** + * Additional information about the status of the transfer. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -717,6 +777,11 @@ public String getReference() { } + /** + * Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -742,6 +807,11 @@ public String getReferenceForBeneficiary() { } + /** + * A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others. + * + * @param referenceForBeneficiary + */ @JsonProperty(JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReferenceForBeneficiary(String referenceForBeneficiary) { @@ -767,6 +837,11 @@ public StatusEnum getStatus() { } + /** + * The result of the transfer. For example, **authorised**, **refused**, or **error**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/transfers/TransferData.java b/src/main/java/com/adyen/model/transfers/TransferData.java index 5e0715ddf..218f8a24b 100644 --- a/src/main/java/com/adyen/model/transfers/TransferData.java +++ b/src/main/java/com/adyen/model/transfers/TransferData.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getReference() { } + /** + * The [`reference`](https://docs.adyen.com/api-explorer/#/transfers/latest/post/transfers__reqParam_reference) from the `/transfers` request. If you haven't provided any, Adyen generates a unique reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transfers/TransferInfo.java b/src/main/java/com/adyen/model/transfers/TransferInfo.java index 4ab40b579..9d89f1f5d 100644 --- a/src/main/java/com/adyen/model/transfers/TransferInfo.java +++ b/src/main/java/com/adyen/model/transfers/TransferInfo.java @@ -182,6 +182,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -207,6 +212,11 @@ public String getBalanceAccountId() { } + /** + * The unique identifier of the source [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -232,6 +242,11 @@ public CategoryEnum getCategory() { } + /** + * The type of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -257,6 +272,11 @@ public CounterpartyInfoV3 getCounterparty() { } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCounterparty(CounterpartyInfoV3 counterparty) { @@ -282,6 +302,11 @@ public String getDescription() { } + /** + * Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?** + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -307,6 +332,11 @@ public String getPaymentInstrumentId() { } + /** + * The unique identifier of the source [payment instrument](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/paymentInstruments__resParam_id). + * + * @param paymentInstrumentId + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrumentId(String paymentInstrumentId) { @@ -332,6 +362,11 @@ public PriorityEnum getPriority() { } + /** + * The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). + * + * @param priority + */ @JsonProperty(JSON_PROPERTY_PRIORITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriority(PriorityEnum priority) { @@ -357,6 +392,11 @@ public String getReference() { } + /** + * Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -382,6 +422,11 @@ public String getReferenceForBeneficiary() { } + /** + * A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others. + * + * @param referenceForBeneficiary + */ @JsonProperty(JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReferenceForBeneficiary(String referenceForBeneficiary) { @@ -407,6 +452,11 @@ public UltimatePartyIdentification getUltimateParty() { } + /** + * ultimateParty + * + * @param ultimateParty + */ @JsonProperty(JSON_PROPERTY_ULTIMATE_PARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUltimateParty(UltimatePartyIdentification ultimateParty) { diff --git a/src/main/java/com/adyen/model/transfers/TransferNotificationValidationFact.java b/src/main/java/com/adyen/model/transfers/TransferNotificationValidationFact.java index 2cfdb3751..b34555d3e 100644 --- a/src/main/java/com/adyen/model/transfers/TransferNotificationValidationFact.java +++ b/src/main/java/com/adyen/model/transfers/TransferNotificationValidationFact.java @@ -63,6 +63,11 @@ public String getResult() { } + /** + * The evaluation result of the validation fact. + * + * @param result + */ @JsonProperty(JSON_PROPERTY_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResult(String result) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * The type of the validation fact. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/transfers/UKLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/UKLocalAccountIdentification.java index 278a4215b..c91114c3a 100644 --- a/src/main/java/com/adyen/model/transfers/UKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/UKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 8-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getSortCode() { } + /** + * The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. + * + * @param sortCode + */ @JsonProperty(JSON_PROPERTY_SORT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSortCode(String sortCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **ukLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/USLocalAccountIdentification.java b/src/main/java/com/adyen/model/transfers/USLocalAccountIdentification.java index e6eb5488a..9f6a38ab0 100644 --- a/src/main/java/com/adyen/model/transfers/USLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transfers/USLocalAccountIdentification.java @@ -139,6 +139,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -164,6 +169,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -189,6 +199,11 @@ public String getRoutingNumber() { } + /** + * The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. + * + * @param routingNumber + */ @JsonProperty(JSON_PROPERTY_ROUTING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoutingNumber(String routingNumber) { @@ -214,6 +229,11 @@ public TypeEnum getType() { } + /** + * **usLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transfers/UltimatePartyIdentification.java b/src/main/java/com/adyen/model/transfers/UltimatePartyIdentification.java index b91f3fbc6..3aff4deca 100644 --- a/src/main/java/com/adyen/model/transfers/UltimatePartyIdentification.java +++ b/src/main/java/com/adyen/model/transfers/UltimatePartyIdentification.java @@ -122,6 +122,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -147,6 +152,11 @@ public LocalDate getDateOfBirth() { } + /** + * The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Should not be before January 1, 1900. Allowed only when `type` is **individual**. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -172,6 +182,11 @@ public String getFirstName() { } + /** + * First name of the individual. Allowed only when `type` is **individual**. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -197,6 +212,11 @@ public String getFullName() { } + /** + * The name of the entity. + * + * @param fullName + */ @JsonProperty(JSON_PROPERTY_FULL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFullName(String fullName) { @@ -222,6 +242,11 @@ public String getLastName() { } + /** + * Last name of the individual. Allowed only when `type` is **individual**. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -247,6 +272,11 @@ public String getReference() { } + /** + * A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -272,6 +302,11 @@ public TypeEnum getType() { } + /** + * The type of entity that owns the bank account. Possible values: **individual**, **organization**, or **unknown**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/AULocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/AULocalAccountIdentification.java index 230315e93..5e085eb48 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/AULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/AULocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBsbCode() { } + /** + * The 6-digit [Bank State Branch (BSB) code](https://en.wikipedia.org/wiki/Bank_state_branch), without separators or whitespace. + * + * @param bsbCode + */ @JsonProperty(JSON_PROPERTY_BSB_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBsbCode(String bsbCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **auLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/AdditionalBankIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/AdditionalBankIdentification.java index bb36c3b4e..9896aa983 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/AdditionalBankIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/AdditionalBankIdentification.java @@ -98,6 +98,11 @@ public String getCode() { } + /** + * The value of the additional bank identification. + * + * @param code + */ @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCode(String code) { @@ -123,6 +128,11 @@ public TypeEnum getType() { } + /** + * The type of additional bank identification, depending on the country. Possible values: * **gbSortCode**: The 6-digit [UK sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or spaces * **usRoutingNumber**: The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or spaces. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/Address.java b/src/main/java/com/adyen/model/transferwebhooks/Address.java index fe3483d68..efbb9e910 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/Address.java +++ b/src/main/java/com/adyen/model/transferwebhooks/Address.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The name of the city. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The two-character ISO 3166-1 alpha-2 country code. For example, **US**, **NL**, or **GB**. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getLine1() { } + /** + * First line of the street address. + * + * @param line1 + */ @JsonProperty(JSON_PROPERTY_LINE1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine1(String line1) { @@ -154,6 +169,11 @@ public String getLine2() { } + /** + * Second line of the street address. + * + * @param line2 + */ @JsonProperty(JSON_PROPERTY_LINE2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLine2(String line2) { @@ -179,6 +199,11 @@ public String getPostalCode() { } + /** + * The postal code. Maximum length: * 5 digits for an address in the US. * 10 characters for an address in all other countries. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { @@ -204,6 +229,11 @@ public String getStateOrProvince() { } + /** + * The two-letter ISO 3166-2 state or province code. For example, **CA** in the US or **ON** in Canada. > Required for the US and Canada. + * + * @param stateOrProvince + */ @JsonProperty(JSON_PROPERTY_STATE_OR_PROVINCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStateOrProvince(String stateOrProvince) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/Amount.java b/src/main/java/com/adyen/model/transferwebhooks/Amount.java index 76cc44ea2..23dc6c44d 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/Amount.java +++ b/src/main/java/com/adyen/model/transferwebhooks/Amount.java @@ -63,6 +63,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -88,6 +93,11 @@ public Long getValue() { } + /** + * The amount of the transaction, in [minor units](https://docs.adyen.com/development-resources/currency-codes). + * + * @param value + */ @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValue(Long value) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/AmountAdjustment.java b/src/main/java/com/adyen/model/transferwebhooks/AmountAdjustment.java index 18b2c52f7..2aa65f46b 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/AmountAdjustment.java +++ b/src/main/java/com/adyen/model/transferwebhooks/AmountAdjustment.java @@ -107,6 +107,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -132,6 +137,11 @@ public AmountAdjustmentTypeEnum getAmountAdjustmentType() { } + /** + * The type of markup that is applied to an authorised payment. Possible values: **exchange**, **forexMarkup**, **authHoldReserve**, **atmMarkup**. + * + * @param amountAdjustmentType + */ @JsonProperty(JSON_PROPERTY_AMOUNT_ADJUSTMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountAdjustmentType(AmountAdjustmentTypeEnum amountAdjustmentType) { @@ -157,6 +167,11 @@ public Integer getBasepoints() { } + /** + * The basepoints associated with the applied markup. + * + * @param basepoints + */ @JsonProperty(JSON_PROPERTY_BASEPOINTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBasepoints(Integer basepoints) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/BRLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/BRLocalAccountIdentification.java index edb6df76d..35daae279 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/BRLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/BRLocalAccountIdentification.java @@ -104,6 +104,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -129,6 +134,11 @@ public String getBankCode() { } + /** + * The 3-digit bank code, with leading zeros. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -154,6 +164,11 @@ public String getBranchNumber() { } + /** + * The bank account branch number, without separators or whitespace. + * + * @param branchNumber + */ @JsonProperty(JSON_PROPERTY_BRANCH_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBranchNumber(String branchNumber) { @@ -179,6 +194,11 @@ public TypeEnum getType() { } + /** + * **brLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/BalanceMutation.java b/src/main/java/com/adyen/model/transferwebhooks/BalanceMutation.java index 9637a88b7..61b2b422b 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/BalanceMutation.java +++ b/src/main/java/com/adyen/model/transferwebhooks/BalanceMutation.java @@ -71,6 +71,11 @@ public Long getBalance() { } + /** + * The amount in the payment's currency that is debited or credited on the balance accounting register. + * + * @param balance + */ @JsonProperty(JSON_PROPERTY_BALANCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalance(Long balance) { @@ -96,6 +101,11 @@ public String getCurrency() { } + /** + * The three-character [ISO currency code](https://docs.adyen.com/development-resources/currency-codes). + * + * @param currency + */ @JsonProperty(JSON_PROPERTY_CURRENCY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCurrency(String currency) { @@ -121,6 +131,11 @@ public Long getReceived() { } + /** + * The amount in the payment's currency that is debited or credited on the received accounting register. + * + * @param received + */ @JsonProperty(JSON_PROPERTY_RECEIVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReceived(Long received) { @@ -146,6 +161,11 @@ public Long getReserved() { } + /** + * The amount in the payment's currency that is debited or credited on the reserved accounting register. + * + * @param reserved + */ @JsonProperty(JSON_PROPERTY_RESERVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReserved(Long reserved) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/BalancePlatformNotificationResponse.java b/src/main/java/com/adyen/model/transferwebhooks/BalancePlatformNotificationResponse.java index f656e51bf..83980abfb 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/BalancePlatformNotificationResponse.java +++ b/src/main/java/com/adyen/model/transferwebhooks/BalancePlatformNotificationResponse.java @@ -59,6 +59,11 @@ public String getNotificationResponse() { } + /** + * Respond with **HTTP 200 OK** and `[accepted]` in the response body to [accept the webhook](https://docs.adyen.com/development-resources/webhooks#accept-notifications). + * + * @param notificationResponse + */ @JsonProperty(JSON_PROPERTY_NOTIFICATION_RESPONSE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNotificationResponse(String notificationResponse) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/BankAccountV3.java b/src/main/java/com/adyen/model/transferwebhooks/BankAccountV3.java index 6c3a3e592..c5025d5cb 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/BankAccountV3.java +++ b/src/main/java/com/adyen/model/transferwebhooks/BankAccountV3.java @@ -65,6 +65,11 @@ public PartyIdentification getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(PartyIdentification accountHolder) { @@ -90,6 +95,11 @@ public BankAccountV3AccountIdentification getAccountIdentification() { } + /** + * accountIdentification + * + * @param accountIdentification + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountIdentification(BankAccountV3AccountIdentification accountIdentification) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/BankCategoryData.java b/src/main/java/com/adyen/model/transferwebhooks/BankCategoryData.java index e654d1826..2a6653a4b 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/BankCategoryData.java +++ b/src/main/java/com/adyen/model/transferwebhooks/BankCategoryData.java @@ -139,6 +139,11 @@ public PriorityEnum getPriority() { } + /** + * The priority for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. Required for transfers with `category` **bank**. Possible values: * **regular**: For normal, low-value transactions. * **fast**: Faster way to transfer funds but has higher fees. Recommended for high-priority, low-value transactions. * **wire**: Fastest way to transfer funds but has the highest fees. Recommended for high-priority, high-value transactions. * **instant**: Instant way to transfer funds in [SEPA countries](https://www.ecb.europa.eu/paym/integration/retail/sepa/html/index.en.html). * **crossBorder**: High-value transfer to a recipient in a different country. * **internal**: Transfer to an Adyen-issued business bank account (by bank account number/IBAN). + * + * @param priority + */ @JsonProperty(JSON_PROPERTY_PRIORITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPriority(PriorityEnum priority) { @@ -164,6 +169,11 @@ public TypeEnum getType() { } + /** + * **bank** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/CALocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/CALocalAccountIdentification.java index 16cb35c97..db58a43c5 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/CALocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/CALocalAccountIdentification.java @@ -143,6 +143,11 @@ public String getAccountNumber() { } + /** + * The 5- to 12-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -168,6 +173,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -193,6 +203,11 @@ public String getInstitutionNumber() { } + /** + * The 3-digit institution number, without separators or whitespace. + * + * @param institutionNumber + */ @JsonProperty(JSON_PROPERTY_INSTITUTION_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setInstitutionNumber(String institutionNumber) { @@ -218,6 +233,11 @@ public String getTransitNumber() { } + /** + * The 5-digit transit number, without separators or whitespace. + * + * @param transitNumber + */ @JsonProperty(JSON_PROPERTY_TRANSIT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransitNumber(String transitNumber) { @@ -243,6 +263,11 @@ public TypeEnum getType() { } + /** + * **caLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/CZLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/CZLocalAccountIdentification.java index 01ff02aa4..c1aa9255b 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/CZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/CZLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 2- to 16-digit bank account number (Číslo účtu) in the following format: - The optional prefix (předčíslí). - The required second part (základní část) which must be at least two non-zero digits. Examples: - **19-123457** (with prefix) - **123457** (without prefix) - **000019-0000123457** (with prefix, normalized) - **000000-0000123457** (without prefix, normalized) + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Kód banky), without separators or whitespace. + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **czLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/CounterpartyV3.java b/src/main/java/com/adyen/model/transferwebhooks/CounterpartyV3.java index c766ef57f..81092cb12 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/CounterpartyV3.java +++ b/src/main/java/com/adyen/model/transferwebhooks/CounterpartyV3.java @@ -73,6 +73,11 @@ public String getBalanceAccountId() { } + /** + * Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + * + * @param balanceAccountId + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccountId(String balanceAccountId) { @@ -98,6 +103,11 @@ public BankAccountV3 getBankAccount() { } + /** + * bankAccount + * + * @param bankAccount + */ @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankAccount(BankAccountV3 bankAccount) { @@ -123,6 +133,11 @@ public MerchantData getMerchant() { } + /** + * merchant + * + * @param merchant + */ @JsonProperty(JSON_PROPERTY_MERCHANT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchant(MerchantData merchant) { @@ -148,6 +163,11 @@ public String getTransferInstrumentId() { } + /** + * Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * + * @param transferInstrumentId + */ @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransferInstrumentId(String transferInstrumentId) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/DKLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/DKLocalAccountIdentification.java index d6e62c1f2..33c7be1a6 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/DKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/DKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4-10 digits bank account number (Kontonummer) (without separators or whitespace). + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBankCode() { } + /** + * The 4-digit bank code (Registreringsnummer) (without separators or whitespace). + * + * @param bankCode + */ @JsonProperty(JSON_PROPERTY_BANK_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBankCode(String bankCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **dkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/HKLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/HKLocalAccountIdentification.java index fc3520819..cd6cd186e 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/HKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/HKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 9- to 15-character bank account number (alphanumeric), without separators or whitespace. Starts with the 3-digit branch code. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingCode() { } + /** + * The 3-digit clearing code, without separators or whitespace. + * + * @param clearingCode + */ @JsonProperty(JSON_PROPERTY_CLEARING_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingCode(String clearingCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **hkLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/HULocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/HULocalAccountIdentification.java index 755f617ee..6c9342ad2 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/HULocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/HULocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 24-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **huLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/IbanAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/IbanAccountIdentification.java index e68d47da5..9c9f4d644 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/IbanAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/IbanAccountIdentification.java @@ -96,6 +96,11 @@ public String getIban() { } + /** + * The international bank account number as defined in the [ISO-13616](https://www.iso.org/standard/81090.html) standard. + * + * @param iban + */ @JsonProperty(JSON_PROPERTY_IBAN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setIban(String iban) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **iban** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/InternalCategoryData.java b/src/main/java/com/adyen/model/transferwebhooks/InternalCategoryData.java index dcbbaa92e..802ced44f 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/InternalCategoryData.java +++ b/src/main/java/com/adyen/model/transferwebhooks/InternalCategoryData.java @@ -100,6 +100,11 @@ public String getModificationMerchantReference() { } + /** + * The capture's merchant reference included in the transfer. + * + * @param modificationMerchantReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationMerchantReference(String modificationMerchantReference) { @@ -125,6 +130,11 @@ public String getModificationPspReference() { } + /** + * The capture reference included in the transfer. + * + * @param modificationPspReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationPspReference(String modificationPspReference) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **internal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/IssuedCard.java b/src/main/java/com/adyen/model/transferwebhooks/IssuedCard.java index 2f6ab4c9a..7cdb6ff4b 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/IssuedCard.java +++ b/src/main/java/com/adyen/model/transferwebhooks/IssuedCard.java @@ -35,14 +35,20 @@ * IssuedCard */ @JsonPropertyOrder({ + IssuedCard.JSON_PROPERTY_AUTHORISATION_TYPE, IssuedCard.JSON_PROPERTY_PAN_ENTRY_MODE, IssuedCard.JSON_PROPERTY_PROCESSING_TYPE, IssuedCard.JSON_PROPERTY_RELAYED_AUTHORISATION_DATA, + IssuedCard.JSON_PROPERTY_SCHEME_TRACE_ID, + IssuedCard.JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID, IssuedCard.JSON_PROPERTY_TYPE, IssuedCard.JSON_PROPERTY_VALIDATION_FACTS }) public class IssuedCard { + public static final String JSON_PROPERTY_AUTHORISATION_TYPE = "authorisationType"; + private String authorisationType; + /** * Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**. */ @@ -144,6 +150,12 @@ public static ProcessingTypeEnum fromValue(String value) { public static final String JSON_PROPERTY_RELAYED_AUTHORISATION_DATA = "relayedAuthorisationData"; private RelayedAuthorisationData relayedAuthorisationData; + public static final String JSON_PROPERTY_SCHEME_TRACE_ID = "schemeTraceId"; + private String schemeTraceId; + + public static final String JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID = "schemeUniqueTransactionId"; + private String schemeUniqueTransactionId; + /** * **issuedCard** */ @@ -186,6 +198,36 @@ public static TypeEnum fromValue(String value) { public IssuedCard() { } + public IssuedCard authorisationType(String authorisationType) { + this.authorisationType = authorisationType; + return this; + } + + /** + * The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation** + * @return authorisationType + **/ + @ApiModelProperty(value = "The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation**") + @JsonProperty(JSON_PROPERTY_AUTHORISATION_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getAuthorisationType() { + return authorisationType; + } + + + /** + * The authorisation type. For example, **defaultAuthorisation**, **preAuthorisation**, **finalAuthorisation** + * + * @param authorisationType + */ + @JsonProperty(JSON_PROPERTY_AUTHORISATION_TYPE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAuthorisationType(String authorisationType) { + this.authorisationType = authorisationType; + } + + public IssuedCard panEntryMode(PanEntryModeEnum panEntryMode) { this.panEntryMode = panEntryMode; return this; @@ -204,6 +246,11 @@ public PanEntryModeEnum getPanEntryMode() { } + /** + * Indicates the method used for entering the PAN to initiate a transaction. Possible values: **manual**, **chip**, **magstripe**, **contactless**, **cof**, **ecommerce**, **token**. + * + * @param panEntryMode + */ @JsonProperty(JSON_PROPERTY_PAN_ENTRY_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPanEntryMode(PanEntryModeEnum panEntryMode) { @@ -229,6 +276,11 @@ public ProcessingTypeEnum getProcessingType() { } + /** + * Contains information about how the payment was processed. For example, **ecommerce** for online or **pos** for in-person payments. + * + * @param processingType + */ @JsonProperty(JSON_PROPERTY_PROCESSING_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setProcessingType(ProcessingTypeEnum processingType) { @@ -254,6 +306,11 @@ public RelayedAuthorisationData getRelayedAuthorisationData() { } + /** + * relayedAuthorisationData + * + * @param relayedAuthorisationData + */ @JsonProperty(JSON_PROPERTY_RELAYED_AUTHORISATION_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRelayedAuthorisationData(RelayedAuthorisationData relayedAuthorisationData) { @@ -261,6 +318,66 @@ public void setRelayedAuthorisationData(RelayedAuthorisationData relayedAuthoris } + public IssuedCard schemeTraceId(String schemeTraceId) { + this.schemeTraceId = schemeTraceId; + return this; + } + + /** + * The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments. + * @return schemeTraceId + **/ + @ApiModelProperty(value = "The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments.") + @JsonProperty(JSON_PROPERTY_SCHEME_TRACE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSchemeTraceId() { + return schemeTraceId; + } + + + /** + * The identifier of the original payment provided by the scheme. The Id could be alphanumeric or numeric depending on the scheme. The schemeTraceID should be referring to an original schemeUniqueTransactionID provided in an earlier payment (not necessarily processed by Adyen). Instances of available schemeTraceId is authAdjustment or recurring payments. + * + * @param schemeTraceId + */ + @JsonProperty(JSON_PROPERTY_SCHEME_TRACE_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSchemeTraceId(String schemeTraceId) { + this.schemeTraceId = schemeTraceId; + } + + + public IssuedCard schemeUniqueTransactionId(String schemeUniqueTransactionId) { + this.schemeUniqueTransactionId = schemeUniqueTransactionId; + return this; + } + + /** + * The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme. + * @return schemeUniqueTransactionId + **/ + @ApiModelProperty(value = "The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme.") + @JsonProperty(JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSchemeUniqueTransactionId() { + return schemeUniqueTransactionId; + } + + + /** + * The unique identifier created by the scheme. The ID could be alphanumeric or numeric depending on the scheme. + * + * @param schemeUniqueTransactionId + */ + @JsonProperty(JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSchemeUniqueTransactionId(String schemeUniqueTransactionId) { + this.schemeUniqueTransactionId = schemeUniqueTransactionId; + } + + public IssuedCard type(TypeEnum type) { this.type = type; return this; @@ -279,6 +396,11 @@ public TypeEnum getType() { } + /** + * **issuedCard** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -312,6 +434,11 @@ public List getValidationFacts() { } + /** + * The evaluation of the validation facts. See [validation checks](https://docs.adyen.com/issuing/validation-checks) for more information. + * + * @param validationFacts + */ @JsonProperty(JSON_PROPERTY_VALIDATION_FACTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValidationFacts(List validationFacts) { @@ -331,25 +458,31 @@ public boolean equals(Object o) { return false; } IssuedCard issuedCard = (IssuedCard) o; - return Objects.equals(this.panEntryMode, issuedCard.panEntryMode) && + return Objects.equals(this.authorisationType, issuedCard.authorisationType) && + Objects.equals(this.panEntryMode, issuedCard.panEntryMode) && Objects.equals(this.processingType, issuedCard.processingType) && Objects.equals(this.relayedAuthorisationData, issuedCard.relayedAuthorisationData) && + Objects.equals(this.schemeTraceId, issuedCard.schemeTraceId) && + Objects.equals(this.schemeUniqueTransactionId, issuedCard.schemeUniqueTransactionId) && Objects.equals(this.type, issuedCard.type) && Objects.equals(this.validationFacts, issuedCard.validationFacts); } @Override public int hashCode() { - return Objects.hash(panEntryMode, processingType, relayedAuthorisationData, type, validationFacts); + return Objects.hash(authorisationType, panEntryMode, processingType, relayedAuthorisationData, schemeTraceId, schemeUniqueTransactionId, type, validationFacts); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class IssuedCard {\n"); + sb.append(" authorisationType: ").append(toIndentedString(authorisationType)).append("\n"); sb.append(" panEntryMode: ").append(toIndentedString(panEntryMode)).append("\n"); sb.append(" processingType: ").append(toIndentedString(processingType)).append("\n"); sb.append(" relayedAuthorisationData: ").append(toIndentedString(relayedAuthorisationData)).append("\n"); + sb.append(" schemeTraceId: ").append(toIndentedString(schemeTraceId)).append("\n"); + sb.append(" schemeUniqueTransactionId: ").append(toIndentedString(schemeUniqueTransactionId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append(" validationFacts: ").append(toIndentedString(validationFacts)).append("\n"); sb.append("}"); diff --git a/src/main/java/com/adyen/model/transferwebhooks/MerchantData.java b/src/main/java/com/adyen/model/transferwebhooks/MerchantData.java index 648b9cd97..c1ed627ba 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/MerchantData.java +++ b/src/main/java/com/adyen/model/transferwebhooks/MerchantData.java @@ -76,6 +76,11 @@ public String getAcquirerId() { } + /** + * The unique identifier of the merchant's acquirer. + * + * @param acquirerId + */ @JsonProperty(JSON_PROPERTY_ACQUIRER_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAcquirerId(String acquirerId) { @@ -101,6 +106,11 @@ public String getMcc() { } + /** + * The merchant category code. + * + * @param mcc + */ @JsonProperty(JSON_PROPERTY_MCC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMcc(String mcc) { @@ -126,6 +136,11 @@ public String getMerchantId() { } + /** + * The merchant identifier. + * + * @param merchantId + */ @JsonProperty(JSON_PROPERTY_MERCHANT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMerchantId(String merchantId) { @@ -151,6 +166,11 @@ public NameLocation getNameLocation() { } + /** + * nameLocation + * + * @param nameLocation + */ @JsonProperty(JSON_PROPERTY_NAME_LOCATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setNameLocation(NameLocation nameLocation) { @@ -176,6 +196,11 @@ public String getPostalCode() { } + /** + * The merchant postal code. + * + * @param postalCode + */ @JsonProperty(JSON_PROPERTY_POSTAL_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPostalCode(String postalCode) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/Modification.java b/src/main/java/com/adyen/model/transferwebhooks/Modification.java index 05169c2bc..11f748cca 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/Modification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/Modification.java @@ -234,6 +234,11 @@ public String getDirection() { } + /** + * The direction of the money movement. + * + * @param direction + */ @JsonProperty(JSON_PROPERTY_DIRECTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirection(String direction) { @@ -259,6 +264,11 @@ public String getId() { } + /** + * Our reference for the modification. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -284,6 +294,11 @@ public String getReference() { } + /** + * Your reference for the modification, used internally within your platform. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -309,6 +324,11 @@ public StatusEnum getStatus() { } + /** + * The status of the transfer event. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -334,6 +354,11 @@ public String getType() { } + /** + * The type of transfer modification. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/NOLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/NOLocalAccountIdentification.java index 750c17620..4266add17 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/NOLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/NOLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 11-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **noLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/NZLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/NZLocalAccountIdentification.java index 7a08a5ace..2e89edcb2 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/NZLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/NZLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 15-16 digit bank account number. The first 2 digits are the bank number, the next 4 digits are the branch number, the next 7 digits are the account number, and the final 2-3 digits are the suffix. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **nzLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/NameLocation.java b/src/main/java/com/adyen/model/transferwebhooks/NameLocation.java index b665ed5c4..e02bd6d4c 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/NameLocation.java +++ b/src/main/java/com/adyen/model/transferwebhooks/NameLocation.java @@ -79,6 +79,11 @@ public String getCity() { } + /** + * The city where the merchant is located. + * + * @param city + */ @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCity(String city) { @@ -104,6 +109,11 @@ public String getCountry() { } + /** + * The country where the merchant is located in [three-letter country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) format. + * + * @param country + */ @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountry(String country) { @@ -129,6 +139,11 @@ public String getCountryOfOrigin() { } + /** + * The home country in [three-digit country code](https://en.wikipedia.org/wiki/ISO_3166-1_numeric) format, used for government-controlled merchants such as embassies. + * + * @param countryOfOrigin + */ @JsonProperty(JSON_PROPERTY_COUNTRY_OF_ORIGIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCountryOfOrigin(String countryOfOrigin) { @@ -154,6 +169,11 @@ public String getName() { } + /** + * The name of the merchant's shop or service. + * + * @param name + */ @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setName(String name) { @@ -179,6 +199,11 @@ public String getRawData() { } + /** + * The raw data. + * + * @param rawData + */ @JsonProperty(JSON_PROPERTY_RAW_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRawData(String rawData) { @@ -204,6 +229,11 @@ public String getState() { } + /** + * The state where the merchant is located. + * + * @param state + */ @JsonProperty(JSON_PROPERTY_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setState(String state) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/NumberAndBicAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/NumberAndBicAccountIdentification.java index 21c306837..a4e6bbc84 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/NumberAndBicAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/NumberAndBicAccountIdentification.java @@ -105,6 +105,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. The length and format depends on the bank or country. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -130,6 +135,11 @@ public AdditionalBankIdentification getAdditionalBankIdentification() { } + /** + * additionalBankIdentification + * + * @param additionalBankIdentification + */ @JsonProperty(JSON_PROPERTY_ADDITIONAL_BANK_IDENTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdditionalBankIdentification(AdditionalBankIdentification additionalBankIdentification) { @@ -155,6 +165,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -180,6 +195,11 @@ public TypeEnum getType() { } + /** + * **numberAndBic** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/PLLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/PLLocalAccountIdentification.java index 32c831c74..fc552814b 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/PLLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/PLLocalAccountIdentification.java @@ -96,6 +96,11 @@ public String getAccountNumber() { } + /** + * The 26-digit bank account number ([Numer rachunku](https://pl.wikipedia.org/wiki/Numer_Rachunku_Bankowego)), without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -121,6 +126,11 @@ public TypeEnum getType() { } + /** + * **plLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/PartyIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/PartyIdentification.java index 6136330ec..c55d3624e 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/PartyIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/PartyIdentification.java @@ -122,6 +122,11 @@ public Address getAddress() { } + /** + * address + * + * @param address + */ @JsonProperty(JSON_PROPERTY_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAddress(Address address) { @@ -147,6 +152,11 @@ public LocalDate getDateOfBirth() { } + /** + * The date of birth of the individual in [ISO-8601](https://www.w3.org/TR/NOTE-datetime) format. For example, **YYYY-MM-DD**. Should not be before January 1, 1900. Allowed only when `type` is **individual**. + * + * @param dateOfBirth + */ @JsonProperty(JSON_PROPERTY_DATE_OF_BIRTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDateOfBirth(LocalDate dateOfBirth) { @@ -172,6 +182,11 @@ public String getFirstName() { } + /** + * First name of the individual. Allowed only when `type` is **individual**. + * + * @param firstName + */ @JsonProperty(JSON_PROPERTY_FIRST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFirstName(String firstName) { @@ -197,6 +212,11 @@ public String getFullName() { } + /** + * The name of the entity. + * + * @param fullName + */ @JsonProperty(JSON_PROPERTY_FULL_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setFullName(String fullName) { @@ -222,6 +242,11 @@ public String getLastName() { } + /** + * Last name of the individual. Allowed only when `type` is **individual**. + * + * @param lastName + */ @JsonProperty(JSON_PROPERTY_LAST_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setLastName(String lastName) { @@ -247,6 +272,11 @@ public String getReference() { } + /** + * A unique reference to identify the party or counterparty involved in transfers. This identifier ensures consistency and uniqueness throughout all transactions initiated to and from the same party. For example, your client's unique wallet or payee ID. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -272,6 +302,11 @@ public TypeEnum getType() { } + /** + * The type of entity that owns the bank account. Possible values: **individual**, **organization**, or **unknown**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/PaymentInstrument.java b/src/main/java/com/adyen/model/transferwebhooks/PaymentInstrument.java index e21d0e793..971a5f0e9 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/PaymentInstrument.java +++ b/src/main/java/com/adyen/model/transferwebhooks/PaymentInstrument.java @@ -71,6 +71,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -96,6 +101,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -121,6 +131,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -146,6 +161,11 @@ public String getTokenType() { } + /** + * The type of wallet the network token is associated with. + * + * @param tokenType + */ @JsonProperty(JSON_PROPERTY_TOKEN_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTokenType(String tokenType) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/PlatformPayment.java b/src/main/java/com/adyen/model/transferwebhooks/PlatformPayment.java index 5476b4ef8..159295119 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/PlatformPayment.java +++ b/src/main/java/com/adyen/model/transferwebhooks/PlatformPayment.java @@ -169,6 +169,11 @@ public String getModificationMerchantReference() { } + /** + * The capture's merchant reference included in the transfer. + * + * @param modificationMerchantReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationMerchantReference(String modificationMerchantReference) { @@ -194,6 +199,11 @@ public String getModificationPspReference() { } + /** + * The capture reference included in the transfer. + * + * @param modificationPspReference + */ @JsonProperty(JSON_PROPERTY_MODIFICATION_PSP_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModificationPspReference(String modificationPspReference) { @@ -219,6 +229,11 @@ public String getPaymentMerchantReference() { } + /** + * The payment's merchant reference included in the transfer. + * + * @param paymentMerchantReference + */ @JsonProperty(JSON_PROPERTY_PAYMENT_MERCHANT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentMerchantReference(String paymentMerchantReference) { @@ -244,6 +259,11 @@ public PlatformPaymentTypeEnum getPlatformPaymentType() { } + /** + * The type of the related split. + * + * @param platformPaymentType + */ @JsonProperty(JSON_PROPERTY_PLATFORM_PAYMENT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPlatformPaymentType(PlatformPaymentTypeEnum platformPaymentType) { @@ -269,6 +289,11 @@ public String getPspPaymentReference() { } + /** + * The payment reference included in the transfer. + * + * @param pspPaymentReference + */ @JsonProperty(JSON_PROPERTY_PSP_PAYMENT_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPspPaymentReference(String pspPaymentReference) { @@ -294,6 +319,11 @@ public TypeEnum getType() { } + /** + * **platformPayment** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/RelayedAuthorisationData.java b/src/main/java/com/adyen/model/transferwebhooks/RelayedAuthorisationData.java index 06064861a..267471b01 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/RelayedAuthorisationData.java +++ b/src/main/java/com/adyen/model/transferwebhooks/RelayedAuthorisationData.java @@ -74,6 +74,11 @@ public Map getMetadata() { } + /** + * Contains key-value pairs of your references and descriptions, for example, `customId`:`your-own-custom-field-12345`. + * + * @param metadata + */ @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMetadata(Map metadata) { @@ -99,6 +104,11 @@ public String getReference() { } + /** + * Your reference for the relayed authorisation data. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/Resource.java b/src/main/java/com/adyen/model/transferwebhooks/Resource.java index fd2cd3be9..ea62a0d26 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/Resource.java +++ b/src/main/java/com/adyen/model/transferwebhooks/Resource.java @@ -68,6 +68,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -93,6 +98,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -118,6 +128,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/ResourceReference.java b/src/main/java/com/adyen/model/transferwebhooks/ResourceReference.java index b79809c2e..c5ea13885 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/ResourceReference.java +++ b/src/main/java/com/adyen/model/transferwebhooks/ResourceReference.java @@ -67,6 +67,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -92,6 +97,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -117,6 +127,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/SELocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/SELocalAccountIdentification.java index 6a2a8429b..01dd91eda 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/SELocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/SELocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 7- to 10-digit bank account number ([Bankkontonummer](https://sv.wikipedia.org/wiki/Bankkonto)), without the clearing number, separators, or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getClearingNumber() { } + /** + * The 4- to 5-digit clearing number ([Clearingnummer](https://sv.wikipedia.org/wiki/Clearingnummer)), without separators or whitespace. + * + * @param clearingNumber + */ @JsonProperty(JSON_PROPERTY_CLEARING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setClearingNumber(String clearingNumber) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **seLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/SGLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/SGLocalAccountIdentification.java index 08269deea..6539dcac2 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/SGLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/SGLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 4- to 19-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getBic() { } + /** + * The bank's 8- or 11-character BIC or SWIFT code. + * + * @param bic + */ @JsonProperty(JSON_PROPERTY_BIC) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBic(String bic) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **sgLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransactionEventViolation.java b/src/main/java/com/adyen/model/transferwebhooks/TransactionEventViolation.java index 44278a7d8..b8846196f 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransactionEventViolation.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransactionEventViolation.java @@ -69,6 +69,11 @@ public String getReason() { } + /** + * An explanation about why the transaction rule failed. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(String reason) { @@ -94,6 +99,11 @@ public TransactionRuleReference getTransactionRule() { } + /** + * transactionRule + * + * @param transactionRule + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionRule(TransactionRuleReference transactionRule) { @@ -119,6 +129,11 @@ public TransactionRuleSource getTransactionRuleSource() { } + /** + * transactionRuleSource + * + * @param transactionRuleSource + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_RULE_SOURCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionRuleSource(TransactionRuleSource transactionRuleSource) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleReference.java b/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleReference.java index 1d8ccb31d..b132d7c25 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleReference.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleReference.java @@ -75,6 +75,11 @@ public String getDescription() { } + /** + * The description of the resource. + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -100,6 +105,11 @@ public String getId() { } + /** + * The unique identifier of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -125,6 +135,11 @@ public String getOutcomeType() { } + /** + * The outcome type of the rule. + * + * @param outcomeType + */ @JsonProperty(JSON_PROPERTY_OUTCOME_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOutcomeType(String outcomeType) { @@ -150,6 +165,11 @@ public String getReference() { } + /** + * The reference for the resource. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -175,6 +195,11 @@ public Integer getScore() { } + /** + * The score of the rule in case it's a scoreBased rule. + * + * @param score + */ @JsonProperty(JSON_PROPERTY_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScore(Integer score) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleSource.java b/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleSource.java index 073b14f94..40650f198 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleSource.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransactionRuleSource.java @@ -63,6 +63,11 @@ public String getId() { } + /** + * ID of the resource, when applicable. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * Indicates the type of resource for which the transaction rule is defined. Possible values: * **PaymentInstrumentGroup** * **PaymentInstrument** * **BalancePlatform** * **EntityUsageConfiguration** * **PlatformRule**: The transaction rule is a platform-wide rule imposed by Adyen. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransactionRulesResult.java b/src/main/java/com/adyen/model/transferwebhooks/TransactionRulesResult.java index 63f1f09bb..24286ede6 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransactionRulesResult.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransactionRulesResult.java @@ -74,6 +74,11 @@ public String getAdvice() { } + /** + * The advice given by the Risk analysis. + * + * @param advice + */ @JsonProperty(JSON_PROPERTY_ADVICE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAdvice(String advice) { @@ -99,6 +104,11 @@ public Boolean getAllHardBlockRulesPassed() { } + /** + * Indicates whether the transaction passed the evaluation for all hardblock rules + * + * @param allHardBlockRulesPassed + */ @JsonProperty(JSON_PROPERTY_ALL_HARD_BLOCK_RULES_PASSED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAllHardBlockRulesPassed(Boolean allHardBlockRulesPassed) { @@ -124,6 +134,11 @@ public Integer getScore() { } + /** + * The score of the Risk analysis. + * + * @param score + */ @JsonProperty(JSON_PROPERTY_SCORE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setScore(Integer score) { @@ -157,6 +172,11 @@ public List getTriggeredTransactionRules() { } + /** + * Array containing all the transaction rules that the transaction triggered. + * + * @param triggeredTransactionRules + */ @JsonProperty(JSON_PROPERTY_TRIGGERED_TRANSACTION_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTriggeredTransactionRules(List triggeredTransactionRules) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferData.java b/src/main/java/com/adyen/model/transferwebhooks/TransferData.java index 2f6a3f7cb..5c01102a3 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransferData.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferData.java @@ -18,12 +18,12 @@ import java.util.HashMap; import com.adyen.model.transferwebhooks.Amount; import com.adyen.model.transferwebhooks.BalanceMutation; -import com.adyen.model.transferwebhooks.CounterpartyV3; import com.adyen.model.transferwebhooks.PaymentInstrument; import com.adyen.model.transferwebhooks.ResourceReference; import com.adyen.model.transferwebhooks.TransactionRulesResult; import com.adyen.model.transferwebhooks.TransferDataCategoryData; import com.adyen.model.transferwebhooks.TransferEvent; +import com.adyen.model.transferwebhooks.TransferNotificationCounterParty; import com.adyen.model.transferwebhooks.TransferNotificationTransferTracking; import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonProperty; @@ -129,7 +129,7 @@ public static CategoryEnum fromValue(String value) { private TransferDataCategoryData categoryData; public static final String JSON_PROPERTY_COUNTERPARTY = "counterparty"; - private CounterpartyV3 counterparty; + private TransferNotificationCounterParty counterparty; public static final String JSON_PROPERTY_CREATION_DATE = "creationDate"; private OffsetDateTime creationDate; @@ -550,6 +550,11 @@ public ResourceReference getAccountHolder() { } + /** + * accountHolder + * + * @param accountHolder + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_HOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountHolder(ResourceReference accountHolder) { @@ -575,6 +580,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -600,6 +610,11 @@ public ResourceReference getBalanceAccount() { } + /** + * balanceAccount + * + * @param balanceAccount + */ @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalanceAccount(ResourceReference balanceAccount) { @@ -625,6 +640,11 @@ public String getBalancePlatform() { } + /** + * The unique identifier of the balance platform. + * + * @param balancePlatform + */ @JsonProperty(JSON_PROPERTY_BALANCE_PLATFORM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalancePlatform(String balancePlatform) { @@ -658,6 +678,11 @@ public List getBalances() { } + /** + * The list of the latest balance statuses in the transfer. + * + * @param balances + */ @JsonProperty(JSON_PROPERTY_BALANCES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBalances(List balances) { @@ -683,6 +708,11 @@ public CategoryEnum getCategory() { } + /** + * The category of transfer. Possible values: - **bank**: Transfer to a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id) or a bank account. - **internal**: Transfer to another [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id) within your platform. - **issuedCard**: Transfer initiated by a Adyen-issued card. - **platformPayment**: Fund movements related to payments that are acquired for your users. + * + * @param category + */ @JsonProperty(JSON_PROPERTY_CATEGORY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategory(CategoryEnum category) { @@ -708,6 +738,11 @@ public TransferDataCategoryData getCategoryData() { } + /** + * categoryData + * + * @param categoryData + */ @JsonProperty(JSON_PROPERTY_CATEGORY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCategoryData(TransferDataCategoryData categoryData) { @@ -715,7 +750,7 @@ public void setCategoryData(TransferDataCategoryData categoryData) { } - public TransferData counterparty(CounterpartyV3 counterparty) { + public TransferData counterparty(TransferNotificationCounterParty counterparty) { this.counterparty = counterparty; return this; } @@ -728,14 +763,19 @@ public TransferData counterparty(CounterpartyV3 counterparty) { @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public CounterpartyV3 getCounterparty() { + public TransferNotificationCounterParty getCounterparty() { return counterparty; } + /** + * counterparty + * + * @param counterparty + */ @JsonProperty(JSON_PROPERTY_COUNTERPARTY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCounterparty(CounterpartyV3 counterparty) { + public void setCounterparty(TransferNotificationCounterParty counterparty) { this.counterparty = counterparty; } @@ -758,6 +798,11 @@ public OffsetDateTime getCreationDate() { } + /** + * The date and time when the event was triggered, in ISO 8601 extended format. For example, **2020-12-18T10:15:30+01:00**. + * + * @param creationDate + */ @JsonProperty(JSON_PROPERTY_CREATION_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setCreationDate(OffsetDateTime creationDate) { @@ -783,6 +828,11 @@ public String getDescription() { } + /** + * Your description for the transfer. It is used by most banks as the transfer description. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. Supported characters: **[a-z] [A-Z] [0-9] / - ?** **: ( ) . , ' + Space** Supported characters for **regular** and **fast** transfers to a US counterparty: **[a-z] [A-Z] [0-9] & $ % # @** **~ = + - _ ' \" ! ?** + * + * @param description + */ @JsonProperty(JSON_PROPERTY_DESCRIPTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDescription(String description) { @@ -808,6 +858,11 @@ public DirectionEnum getDirection() { } + /** + * The direction of the transfer. Possible values: **incoming**, **outgoing**. + * + * @param direction + */ @JsonProperty(JSON_PROPERTY_DIRECTION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setDirection(DirectionEnum direction) { @@ -841,6 +896,11 @@ public List getEvents() { } + /** + * The list of events leading up to the current status of the transfer. + * + * @param events + */ @JsonProperty(JSON_PROPERTY_EVENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEvents(List events) { @@ -866,6 +926,11 @@ public String getId() { } + /** + * The ID of the resource. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -891,6 +956,11 @@ public PaymentInstrument getPaymentInstrument() { } + /** + * paymentInstrument + * + * @param paymentInstrument + */ @JsonProperty(JSON_PROPERTY_PAYMENT_INSTRUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setPaymentInstrument(PaymentInstrument paymentInstrument) { @@ -916,6 +986,11 @@ public ReasonEnum getReason() { } + /** + * Additional information about the status of the transfer. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -941,6 +1016,11 @@ public String getReference() { } + /** + * Your reference for the transfer, used internally within your platform. If you don't provide this in the request, Adyen generates a unique reference. + * + * @param reference + */ @JsonProperty(JSON_PROPERTY_REFERENCE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReference(String reference) { @@ -966,6 +1046,11 @@ public String getReferenceForBeneficiary() { } + /** + * A reference that is sent to the recipient. This reference is also sent in all webhooks related to the transfer, so you can use it to track statuses for both the source and recipient of funds. Supported characters: **a-z**, **A-Z**, **0-9**. The maximum length depends on the `category`. - **internal**: 80 characters - **bank**: 35 characters when transferring to an IBAN, 15 characters for others. + * + * @param referenceForBeneficiary + */ @JsonProperty(JSON_PROPERTY_REFERENCE_FOR_BENEFICIARY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReferenceForBeneficiary(String referenceForBeneficiary) { @@ -991,6 +1076,11 @@ public Integer getSequenceNumber() { } + /** + * The sequence number of the transfer notification. The numbers start from 1 and increase with each new notification for a specific transfer. It can help you restore the correct sequence of events even if they arrive out of order. + * + * @param sequenceNumber + */ @JsonProperty(JSON_PROPERTY_SEQUENCE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSequenceNumber(Integer sequenceNumber) { @@ -1016,6 +1106,11 @@ public StatusEnum getStatus() { } + /** + * The result of the transfer. For example, **authorised**, **refused**, or **error**. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -1041,6 +1136,11 @@ public TransferNotificationTransferTracking getTracking() { } + /** + * tracking + * + * @param tracking + */ @JsonProperty(JSON_PROPERTY_TRACKING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTracking(TransferNotificationTransferTracking tracking) { @@ -1066,6 +1166,11 @@ public TransactionRulesResult getTransactionRulesResult() { } + /** + * transactionRulesResult + * + * @param transactionRulesResult + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_RULES_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionRulesResult(TransactionRulesResult transactionRulesResult) { @@ -1091,6 +1196,11 @@ public TypeEnum getType() { } + /** + * The type of transfer or transaction. For example, **refund**, **payment**, **internalTransfer**, **bankTransfer**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferEvent.java b/src/main/java/com/adyen/model/transferwebhooks/TransferEvent.java index dedc3e863..3cb10cf43 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransferEvent.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferEvent.java @@ -47,8 +47,6 @@ TransferEvent.JSON_PROPERTY_MUTATIONS, TransferEvent.JSON_PROPERTY_ORIGINAL_AMOUNT, TransferEvent.JSON_PROPERTY_REASON, - TransferEvent.JSON_PROPERTY_SCHEME_TRACE_I_D, - TransferEvent.JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_I_D, TransferEvent.JSON_PROPERTY_STATUS, TransferEvent.JSON_PROPERTY_TRANSACTION_ID, TransferEvent.JSON_PROPERTY_TYPE, @@ -147,12 +145,6 @@ public static ReasonEnum fromValue(String value) { public static final String JSON_PROPERTY_REASON = "reason"; private ReasonEnum reason; - public static final String JSON_PROPERTY_SCHEME_TRACE_I_D = "schemeTraceID"; - private String schemeTraceID; - - public static final String JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_I_D = "schemeUniqueTransactionID"; - private String schemeUniqueTransactionID; - /** * The status of the transfer event. */ @@ -383,6 +375,11 @@ public Amount getAmount() { } + /** + * amount + * + * @param amount + */ @JsonProperty(JSON_PROPERTY_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmount(Amount amount) { @@ -416,6 +413,11 @@ public List getAmountAdjustments() { } + /** + * The amount adjustments in this transfer. + * + * @param amountAdjustments + */ @JsonProperty(JSON_PROPERTY_AMOUNT_ADJUSTMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAmountAdjustments(List amountAdjustments) { @@ -441,6 +443,11 @@ public OffsetDateTime getBookingDate() { } + /** + * The date when the transfer request was sent. + * + * @param bookingDate + */ @JsonProperty(JSON_PROPERTY_BOOKING_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setBookingDate(OffsetDateTime bookingDate) { @@ -466,6 +473,11 @@ public OffsetDateTime getEstimatedArrivalTime() { } + /** + * The estimated time the beneficiary should have access to the funds. + * + * @param estimatedArrivalTime + */ @JsonProperty(JSON_PROPERTY_ESTIMATED_ARRIVAL_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEstimatedArrivalTime(OffsetDateTime estimatedArrivalTime) { @@ -491,6 +503,11 @@ public String getId() { } + /** + * The unique identifier of the transfer event. + * + * @param id + */ @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setId(String id) { @@ -516,6 +533,11 @@ public Modification getModification() { } + /** + * modification + * + * @param modification + */ @JsonProperty(JSON_PROPERTY_MODIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setModification(Modification modification) { @@ -549,6 +571,11 @@ public List getMutations() { } + /** + * The list of the balance mutation per event. + * + * @param mutations + */ @JsonProperty(JSON_PROPERTY_MUTATIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setMutations(List mutations) { @@ -574,6 +601,11 @@ public Amount getOriginalAmount() { } + /** + * originalAmount + * + * @param originalAmount + */ @JsonProperty(JSON_PROPERTY_ORIGINAL_AMOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setOriginalAmount(Amount originalAmount) { @@ -599,6 +631,11 @@ public ReasonEnum getReason() { } + /** + * The reason for the transfer status. + * + * @param reason + */ @JsonProperty(JSON_PROPERTY_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setReason(ReasonEnum reason) { @@ -606,56 +643,6 @@ public void setReason(ReasonEnum reason) { } - public TransferEvent schemeTraceID(String schemeTraceID) { - this.schemeTraceID = schemeTraceID; - return this; - } - - /** - * SchemeTraceID retrieved from scheme. - * @return schemeTraceID - **/ - @ApiModelProperty(value = "SchemeTraceID retrieved from scheme.") - @JsonProperty(JSON_PROPERTY_SCHEME_TRACE_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSchemeTraceID() { - return schemeTraceID; - } - - - @JsonProperty(JSON_PROPERTY_SCHEME_TRACE_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSchemeTraceID(String schemeTraceID) { - this.schemeTraceID = schemeTraceID; - } - - - public TransferEvent schemeUniqueTransactionID(String schemeUniqueTransactionID) { - this.schemeUniqueTransactionID = schemeUniqueTransactionID; - return this; - } - - /** - * SchemeUniqueTransactionID retrieved from scheme. - * @return schemeUniqueTransactionID - **/ - @ApiModelProperty(value = "SchemeUniqueTransactionID retrieved from scheme.") - @JsonProperty(JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - - public String getSchemeUniqueTransactionID() { - return schemeUniqueTransactionID; - } - - - @JsonProperty(JSON_PROPERTY_SCHEME_UNIQUE_TRANSACTION_I_D) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSchemeUniqueTransactionID(String schemeUniqueTransactionID) { - this.schemeUniqueTransactionID = schemeUniqueTransactionID; - } - - public TransferEvent status(StatusEnum status) { this.status = status; return this; @@ -674,6 +661,11 @@ public StatusEnum getStatus() { } + /** + * The status of the transfer event. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { @@ -699,6 +691,11 @@ public String getTransactionId() { } + /** + * The id of the transaction that is related to this accounting event. Only sent for events of type **accounting** where the balance changes. + * + * @param transactionId + */ @JsonProperty(JSON_PROPERTY_TRANSACTION_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setTransactionId(String transactionId) { @@ -724,6 +721,11 @@ public TypeEnum getType() { } + /** + * The type of the transfer event. Possible values: **accounting**, **tracking**. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { @@ -749,6 +751,11 @@ public OffsetDateTime getUpdateDate() { } + /** + * The date when the tracking status was updated. + * + * @param updateDate + */ @JsonProperty(JSON_PROPERTY_UPDATE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setUpdateDate(OffsetDateTime updateDate) { @@ -774,6 +781,11 @@ public OffsetDateTime getValueDate() { } + /** + * A future date, when the funds are expected to be deducted from or credited to the balance account. + * + * @param valueDate + */ @JsonProperty(JSON_PROPERTY_VALUE_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setValueDate(OffsetDateTime valueDate) { @@ -802,8 +814,6 @@ public boolean equals(Object o) { Objects.equals(this.mutations, transferEvent.mutations) && Objects.equals(this.originalAmount, transferEvent.originalAmount) && Objects.equals(this.reason, transferEvent.reason) && - Objects.equals(this.schemeTraceID, transferEvent.schemeTraceID) && - Objects.equals(this.schemeUniqueTransactionID, transferEvent.schemeUniqueTransactionID) && Objects.equals(this.status, transferEvent.status) && Objects.equals(this.transactionId, transferEvent.transactionId) && Objects.equals(this.type, transferEvent.type) && @@ -813,7 +823,7 @@ public boolean equals(Object o) { @Override public int hashCode() { - return Objects.hash(amount, amountAdjustments, bookingDate, estimatedArrivalTime, id, modification, mutations, originalAmount, reason, schemeTraceID, schemeUniqueTransactionID, status, transactionId, type, updateDate, valueDate); + return Objects.hash(amount, amountAdjustments, bookingDate, estimatedArrivalTime, id, modification, mutations, originalAmount, reason, status, transactionId, type, updateDate, valueDate); } @Override @@ -829,8 +839,6 @@ public String toString() { sb.append(" mutations: ").append(toIndentedString(mutations)).append("\n"); sb.append(" originalAmount: ").append(toIndentedString(originalAmount)).append("\n"); sb.append(" reason: ").append(toIndentedString(reason)).append("\n"); - sb.append(" schemeTraceID: ").append(toIndentedString(schemeTraceID)).append("\n"); - sb.append(" schemeUniqueTransactionID: ").append(toIndentedString(schemeUniqueTransactionID)).append("\n"); sb.append(" status: ").append(toIndentedString(status)).append("\n"); sb.append(" transactionId: ").append(toIndentedString(transactionId)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationCounterParty.java b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationCounterParty.java new file mode 100644 index 000000000..3e75594a9 --- /dev/null +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationCounterParty.java @@ -0,0 +1,243 @@ +/* + * Transfer webhooks + * + * The version of the OpenAPI document: 4 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.transferwebhooks; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.adyen.model.transferwebhooks.BankAccountV3; +import com.adyen.model.transferwebhooks.TransferNotificationMerchantData; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * TransferNotificationCounterParty + */ +@JsonPropertyOrder({ + TransferNotificationCounterParty.JSON_PROPERTY_BALANCE_ACCOUNT_ID, + TransferNotificationCounterParty.JSON_PROPERTY_BANK_ACCOUNT, + TransferNotificationCounterParty.JSON_PROPERTY_MERCHANT, + TransferNotificationCounterParty.JSON_PROPERTY_TRANSFER_INSTRUMENT_ID +}) + +public class TransferNotificationCounterParty { + public static final String JSON_PROPERTY_BALANCE_ACCOUNT_ID = "balanceAccountId"; + private String balanceAccountId; + + public static final String JSON_PROPERTY_BANK_ACCOUNT = "bankAccount"; + private BankAccountV3 bankAccount; + + public static final String JSON_PROPERTY_MERCHANT = "merchant"; + private TransferNotificationMerchantData merchant; + + public static final String JSON_PROPERTY_TRANSFER_INSTRUMENT_ID = "transferInstrumentId"; + private String transferInstrumentId; + + public TransferNotificationCounterParty() { + } + + public TransferNotificationCounterParty balanceAccountId(String balanceAccountId) { + this.balanceAccountId = balanceAccountId; + return this; + } + + /** + * Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + * @return balanceAccountId + **/ + @ApiModelProperty(value = "Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id).") + @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getBalanceAccountId() { + return balanceAccountId; + } + + + /** + * Unique identifier of the [balance account](https://docs.adyen.com/api-explorer/#/balanceplatform/latest/post/balanceAccounts__resParam_id). + * + * @param balanceAccountId + */ + @JsonProperty(JSON_PROPERTY_BALANCE_ACCOUNT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBalanceAccountId(String balanceAccountId) { + this.balanceAccountId = balanceAccountId; + } + + + public TransferNotificationCounterParty bankAccount(BankAccountV3 bankAccount) { + this.bankAccount = bankAccount; + return this; + } + + /** + * Get bankAccount + * @return bankAccount + **/ + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public BankAccountV3 getBankAccount() { + return bankAccount; + } + + + /** + * bankAccount + * + * @param bankAccount + */ + @JsonProperty(JSON_PROPERTY_BANK_ACCOUNT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setBankAccount(BankAccountV3 bankAccount) { + this.bankAccount = bankAccount; + } + + + public TransferNotificationCounterParty merchant(TransferNotificationMerchantData merchant) { + this.merchant = merchant; + return this; + } + + /** + * Get merchant + * @return merchant + **/ + @ApiModelProperty(value = "") + @JsonProperty(JSON_PROPERTY_MERCHANT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public TransferNotificationMerchantData getMerchant() { + return merchant; + } + + + /** + * merchant + * + * @param merchant + */ + @JsonProperty(JSON_PROPERTY_MERCHANT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMerchant(TransferNotificationMerchantData merchant) { + this.merchant = merchant; + } + + + public TransferNotificationCounterParty transferInstrumentId(String transferInstrumentId) { + this.transferInstrumentId = transferInstrumentId; + return this; + } + + /** + * Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * @return transferInstrumentId + **/ + @ApiModelProperty(value = "Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).") + @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTransferInstrumentId() { + return transferInstrumentId; + } + + + /** + * Unique identifier of the [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id). + * + * @param transferInstrumentId + */ + @JsonProperty(JSON_PROPERTY_TRANSFER_INSTRUMENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTransferInstrumentId(String transferInstrumentId) { + this.transferInstrumentId = transferInstrumentId; + } + + + /** + * Return true if this TransferNotificationCounterParty object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TransferNotificationCounterParty transferNotificationCounterParty = (TransferNotificationCounterParty) o; + return Objects.equals(this.balanceAccountId, transferNotificationCounterParty.balanceAccountId) && + Objects.equals(this.bankAccount, transferNotificationCounterParty.bankAccount) && + Objects.equals(this.merchant, transferNotificationCounterParty.merchant) && + Objects.equals(this.transferInstrumentId, transferNotificationCounterParty.transferInstrumentId); + } + + @Override + public int hashCode() { + return Objects.hash(balanceAccountId, bankAccount, merchant, transferInstrumentId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TransferNotificationCounterParty {\n"); + sb.append(" balanceAccountId: ").append(toIndentedString(balanceAccountId)).append("\n"); + sb.append(" bankAccount: ").append(toIndentedString(bankAccount)).append("\n"); + sb.append(" merchant: ").append(toIndentedString(merchant)).append("\n"); + sb.append(" transferInstrumentId: ").append(toIndentedString(transferInstrumentId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of TransferNotificationCounterParty given an JSON string + * + * @param jsonString JSON string + * @return An instance of TransferNotificationCounterParty + * @throws JsonProcessingException if the JSON string is invalid with respect to TransferNotificationCounterParty + */ + public static TransferNotificationCounterParty fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, TransferNotificationCounterParty.class); + } +/** + * Convert an instance of TransferNotificationCounterParty to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationMerchantData.java b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationMerchantData.java new file mode 100644 index 000000000..aeef34ee5 --- /dev/null +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationMerchantData.java @@ -0,0 +1,349 @@ +/* + * Transfer webhooks + * + * The version of the OpenAPI document: 4 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + + +package com.adyen.model.transferwebhooks; + +import java.util.Objects; +import java.util.Arrays; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import io.swagger.annotations.ApiModel; +import io.swagger.annotations.ApiModelProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.core.JsonProcessingException; + + +/** + * TransferNotificationMerchantData + */ +@JsonPropertyOrder({ + TransferNotificationMerchantData.JSON_PROPERTY_ACQUIRER_ID, + TransferNotificationMerchantData.JSON_PROPERTY_CITY, + TransferNotificationMerchantData.JSON_PROPERTY_COUNTRY, + TransferNotificationMerchantData.JSON_PROPERTY_MCC, + TransferNotificationMerchantData.JSON_PROPERTY_MERCHANT_ID, + TransferNotificationMerchantData.JSON_PROPERTY_NAME, + TransferNotificationMerchantData.JSON_PROPERTY_POSTAL_CODE +}) + +public class TransferNotificationMerchantData { + public static final String JSON_PROPERTY_ACQUIRER_ID = "acquirerId"; + private String acquirerId; + + public static final String JSON_PROPERTY_CITY = "city"; + private String city; + + public static final String JSON_PROPERTY_COUNTRY = "country"; + private String country; + + public static final String JSON_PROPERTY_MCC = "mcc"; + private String mcc; + + public static final String JSON_PROPERTY_MERCHANT_ID = "merchantId"; + private String merchantId; + + public static final String JSON_PROPERTY_NAME = "name"; + private String name; + + public static final String JSON_PROPERTY_POSTAL_CODE = "postalCode"; + private String postalCode; + + public TransferNotificationMerchantData() { + } + + public TransferNotificationMerchantData acquirerId(String acquirerId) { + this.acquirerId = acquirerId; + return this; + } + + /** + * The unique identifier of the merchant's acquirer. + * @return acquirerId + **/ + @ApiModelProperty(value = "The unique identifier of the merchant's acquirer.") + @JsonProperty(JSON_PROPERTY_ACQUIRER_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getAcquirerId() { + return acquirerId; + } + + + /** + * The unique identifier of the merchant's acquirer. + * + * @param acquirerId + */ + @JsonProperty(JSON_PROPERTY_ACQUIRER_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAcquirerId(String acquirerId) { + this.acquirerId = acquirerId; + } + + + public TransferNotificationMerchantData city(String city) { + this.city = city; + return this; + } + + /** + * The city where the merchant is located. + * @return city + **/ + @ApiModelProperty(value = "The city where the merchant is located.") + @JsonProperty(JSON_PROPERTY_CITY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCity() { + return city; + } + + + /** + * The city where the merchant is located. + * + * @param city + */ + @JsonProperty(JSON_PROPERTY_CITY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCity(String city) { + this.city = city; + } + + + public TransferNotificationMerchantData country(String country) { + this.country = country; + return this; + } + + /** + * The country where the merchant is located. + * @return country + **/ + @ApiModelProperty(value = "The country where the merchant is located.") + @JsonProperty(JSON_PROPERTY_COUNTRY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getCountry() { + return country; + } + + + /** + * The country where the merchant is located. + * + * @param country + */ + @JsonProperty(JSON_PROPERTY_COUNTRY) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCountry(String country) { + this.country = country; + } + + + public TransferNotificationMerchantData mcc(String mcc) { + this.mcc = mcc; + return this; + } + + /** + * The merchant category code. + * @return mcc + **/ + @ApiModelProperty(value = "The merchant category code.") + @JsonProperty(JSON_PROPERTY_MCC) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMcc() { + return mcc; + } + + + /** + * The merchant category code. + * + * @param mcc + */ + @JsonProperty(JSON_PROPERTY_MCC) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMcc(String mcc) { + this.mcc = mcc; + } + + + public TransferNotificationMerchantData merchantId(String merchantId) { + this.merchantId = merchantId; + return this; + } + + /** + * The merchant identifier. + * @return merchantId + **/ + @ApiModelProperty(value = "The merchant identifier.") + @JsonProperty(JSON_PROPERTY_MERCHANT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMerchantId() { + return merchantId; + } + + + /** + * The merchant identifier. + * + * @param merchantId + */ + @JsonProperty(JSON_PROPERTY_MERCHANT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMerchantId(String merchantId) { + this.merchantId = merchantId; + } + + + public TransferNotificationMerchantData name(String name) { + this.name = name; + return this; + } + + /** + * The name of the merchant's shop or service. + * @return name + **/ + @ApiModelProperty(value = "The name of the merchant's shop or service.") + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getName() { + return name; + } + + + /** + * The name of the merchant's shop or service. + * + * @param name + */ + @JsonProperty(JSON_PROPERTY_NAME) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(String name) { + this.name = name; + } + + + public TransferNotificationMerchantData postalCode(String postalCode) { + this.postalCode = postalCode; + return this; + } + + /** + * The merchant postal code. + * @return postalCode + **/ + @ApiModelProperty(value = "The merchant postal code.") + @JsonProperty(JSON_PROPERTY_POSTAL_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getPostalCode() { + return postalCode; + } + + + /** + * The merchant postal code. + * + * @param postalCode + */ + @JsonProperty(JSON_PROPERTY_POSTAL_CODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPostalCode(String postalCode) { + this.postalCode = postalCode; + } + + + /** + * Return true if this TransferNotificationMerchantData object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + TransferNotificationMerchantData transferNotificationMerchantData = (TransferNotificationMerchantData) o; + return Objects.equals(this.acquirerId, transferNotificationMerchantData.acquirerId) && + Objects.equals(this.city, transferNotificationMerchantData.city) && + Objects.equals(this.country, transferNotificationMerchantData.country) && + Objects.equals(this.mcc, transferNotificationMerchantData.mcc) && + Objects.equals(this.merchantId, transferNotificationMerchantData.merchantId) && + Objects.equals(this.name, transferNotificationMerchantData.name) && + Objects.equals(this.postalCode, transferNotificationMerchantData.postalCode); + } + + @Override + public int hashCode() { + return Objects.hash(acquirerId, city, country, mcc, merchantId, name, postalCode); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class TransferNotificationMerchantData {\n"); + sb.append(" acquirerId: ").append(toIndentedString(acquirerId)).append("\n"); + sb.append(" city: ").append(toIndentedString(city)).append("\n"); + sb.append(" country: ").append(toIndentedString(country)).append("\n"); + sb.append(" mcc: ").append(toIndentedString(mcc)).append("\n"); + sb.append(" merchantId: ").append(toIndentedString(merchantId)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" postalCode: ").append(toIndentedString(postalCode)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + +/** + * Create an instance of TransferNotificationMerchantData given an JSON string + * + * @param jsonString JSON string + * @return An instance of TransferNotificationMerchantData + * @throws JsonProcessingException if the JSON string is invalid with respect to TransferNotificationMerchantData + */ + public static TransferNotificationMerchantData fromJson(String jsonString) throws JsonProcessingException { + return JSON.getMapper().readValue(jsonString, TransferNotificationMerchantData.class); + } +/** + * Convert an instance of TransferNotificationMerchantData to an JSON string + * + * @return JSON string + */ + public String toJson() throws JsonProcessingException { + return JSON.getMapper().writeValueAsString(this); + } +} + diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationRequest.java b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationRequest.java index c342578f3..ebafe4e73 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationRequest.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationRequest.java @@ -103,6 +103,11 @@ public TransferData getData() { } + /** + * data + * + * @param data + */ @JsonProperty(JSON_PROPERTY_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setData(TransferData data) { @@ -128,6 +133,11 @@ public String getEnvironment() { } + /** + * The environment from which the webhook originated. Possible values: **test**, **live**. + * + * @param environment + */ @JsonProperty(JSON_PROPERTY_ENVIRONMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEnvironment(String environment) { @@ -153,6 +163,11 @@ public TypeEnum getType() { } + /** + * The type of webhook. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationTransferTracking.java b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationTransferTracking.java index 11e59930a..e0f88ca3d 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationTransferTracking.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationTransferTracking.java @@ -97,6 +97,11 @@ public OffsetDateTime getEstimatedArrivalTime() { } + /** + * The estimated time the beneficiary should have access to the funds. + * + * @param estimatedArrivalTime + */ @JsonProperty(JSON_PROPERTY_ESTIMATED_ARRIVAL_TIME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setEstimatedArrivalTime(OffsetDateTime estimatedArrivalTime) { @@ -122,6 +127,11 @@ public StatusEnum getStatus() { } + /** + * The tracking status of the transfer. + * + * @param status + */ @JsonProperty(JSON_PROPERTY_STATUS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setStatus(StatusEnum status) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationValidationFact.java b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationValidationFact.java index 99cad8874..b600ae16d 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationValidationFact.java +++ b/src/main/java/com/adyen/model/transferwebhooks/TransferNotificationValidationFact.java @@ -63,6 +63,11 @@ public String getResult() { } + /** + * The evaluation result of the validation fact. + * + * @param result + */ @JsonProperty(JSON_PROPERTY_RESULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setResult(String result) { @@ -88,6 +93,11 @@ public String getType() { } + /** + * The type of the validation fact. + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(String type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/UKLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/UKLocalAccountIdentification.java index ca37ab2e1..a1a91acd7 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/UKLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/UKLocalAccountIdentification.java @@ -100,6 +100,11 @@ public String getAccountNumber() { } + /** + * The 8-digit bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -125,6 +130,11 @@ public String getSortCode() { } + /** + * The 6-digit [sort code](https://en.wikipedia.org/wiki/Sort_code), without separators or whitespace. + * + * @param sortCode + */ @JsonProperty(JSON_PROPERTY_SORT_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setSortCode(String sortCode) { @@ -150,6 +160,11 @@ public TypeEnum getType() { } + /** + * **ukLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/model/transferwebhooks/USLocalAccountIdentification.java b/src/main/java/com/adyen/model/transferwebhooks/USLocalAccountIdentification.java index 8a588f2b0..fe79db3a7 100644 --- a/src/main/java/com/adyen/model/transferwebhooks/USLocalAccountIdentification.java +++ b/src/main/java/com/adyen/model/transferwebhooks/USLocalAccountIdentification.java @@ -139,6 +139,11 @@ public String getAccountNumber() { } + /** + * The bank account number, without separators or whitespace. + * + * @param accountNumber + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountNumber(String accountNumber) { @@ -164,6 +169,11 @@ public AccountTypeEnum getAccountType() { } + /** + * The bank account type. Possible values: **checking** or **savings**. Defaults to **checking**. + * + * @param accountType + */ @JsonProperty(JSON_PROPERTY_ACCOUNT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setAccountType(AccountTypeEnum accountType) { @@ -189,6 +199,11 @@ public String getRoutingNumber() { } + /** + * The 9-digit [routing number](https://en.wikipedia.org/wiki/ABA_routing_transit_number), without separators or whitespace. + * + * @param routingNumber + */ @JsonProperty(JSON_PROPERTY_ROUTING_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setRoutingNumber(String routingNumber) { @@ -214,6 +229,11 @@ public TypeEnum getType() { } + /** + * **usLocal** + * + * @param type + */ @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) public void setType(TypeEnum type) { diff --git a/src/main/java/com/adyen/service/BalanceControlApi.java b/src/main/java/com/adyen/service/BalanceControlApi.java index 317063fc0..a90793a9a 100644 --- a/src/main/java/com/adyen/service/BalanceControlApi.java +++ b/src/main/java/com/adyen/service/BalanceControlApi.java @@ -1,6 +1,5 @@ /* * Adyen Balance Control API - * The Balance Control API lets you transfer funds between merchant accounts that belong to the same legal entity and are under the same company account. ## Authentication To connect to the Balance Control API, you must authenticate your requests with an [API key or basic auth username and password](https://docs.adyen.com/development-resources/api-authentication). To learn how you can generate these, see [API credentials](https://docs.adyen.com/development-resources/api-credentials).Here is an example of authenticating a request with an API key: ``` curl -H \"X-API-Key: Your_API_key\" \\ -H \"Content-Type: application/json\" \\ ... ``` Note that when going live, you need to generate API credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning The Balance Control API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BalanceControl/v1/balanceTransfer ``` * * The version of the OpenAPI document: 1 * @@ -24,7 +23,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class BalanceControlApi extends Service { public static final String API_VERSION = "1"; @@ -32,7 +30,7 @@ public class BalanceControlApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public BalanceControlApi(Client client) { @@ -41,7 +39,7 @@ public BalanceControlApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/BinLookupApi.java b/src/main/java/com/adyen/service/BinLookupApi.java index 6791029db..4b08143d6 100644 --- a/src/main/java/com/adyen/service/BinLookupApi.java +++ b/src/main/java/com/adyen/service/BinLookupApi.java @@ -1,6 +1,5 @@ /* * Adyen BinLookup API - * The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN. ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning The BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/BinLookup/v54/get3dsAvailability ```## Going live To authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v54/get3dsAvailability ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 54 * @@ -27,7 +26,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class BinLookupApi extends Service { public static final String API_VERSION = "54"; @@ -35,7 +33,7 @@ public class BinLookupApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public BinLookupApi(Client client) { @@ -44,7 +42,7 @@ public BinLookupApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/DataProtectionApi.java b/src/main/java/com/adyen/service/DataProtectionApi.java index 5166b3d4c..6935a10f7 100644 --- a/src/main/java/com/adyen/service/DataProtectionApi.java +++ b/src/main/java/com/adyen/service/DataProtectionApi.java @@ -1,6 +1,5 @@ /* * Adyen Data Protection API - * Adyen Data Protection API provides a way for you to process [Subject Erasure Requests](https://gdpr-info.eu/art-17-gdpr/) as mandated in GDPR. Use our API to submit a request to delete shopper's data, including payment details and other related information (for example, delivery address or shopper email).## Authentication Each request to the Data Protection API must be signed with an API key. Get your API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Data Protection Service API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DataProtectionService/v1/requestSubjectErasure ``` * * The version of the OpenAPI document: 1 * @@ -25,7 +24,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class DataProtectionApi extends Service { public static final String API_VERSION = "1"; @@ -33,7 +31,7 @@ public class DataProtectionApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public DataProtectionApi(Client client) { @@ -42,7 +40,7 @@ public DataProtectionApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/DisputesApi.java b/src/main/java/com/adyen/service/DisputesApi.java index a7826a95a..4e2836cc6 100644 --- a/src/main/java/com/adyen/service/DisputesApi.java +++ b/src/main/java/com/adyen/service/DisputesApi.java @@ -1,6 +1,5 @@ /* * Disputes API - * You can use the [Disputes API](https://docs.adyen.com/risk-management/disputes-api) to automate the dispute handling process so that you can respond to disputes and chargebacks as soon as they are initiated. The Disputes API lets you retrieve defense reasons, supply and delete defense documents, and accept or defend disputes. ## Authentication Each request to the Disputes API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Disputes API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://ca-test.adyen.com/ca/services/DisputeService/v30/defendDispute ``` * * The version of the OpenAPI document: 30 * @@ -33,7 +32,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class DisputesApi extends Service { public static final String API_VERSION = "30"; @@ -41,7 +39,7 @@ public class DisputesApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public DisputesApi(Client client) { @@ -50,7 +48,7 @@ public DisputesApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/PaymentApi.java b/src/main/java/com/adyen/service/PaymentApi.java index 361ff0a35..1c43ccbb3 100644 --- a/src/main/java/com/adyen/service/PaymentApi.java +++ b/src/main/java/com/adyen/service/PaymentApi.java @@ -1,6 +1,5 @@ /* * Adyen Payment API - * A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods. To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -40,7 +39,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class PaymentApi extends Service { public static final String API_VERSION = "68"; @@ -48,7 +46,7 @@ public class PaymentApi extends Service { protected String baseURL; /** - * Modifications constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public PaymentApi(Client client) { @@ -57,7 +55,7 @@ public PaymentApi(Client client) { } /** - * Modifications constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/PosTerminalManagementApi.java b/src/main/java/com/adyen/service/PosTerminalManagementApi.java index 73dd5bab5..1b454c6b6 100644 --- a/src/main/java/com/adyen/service/PosTerminalManagementApi.java +++ b/src/main/java/com/adyen/service/PosTerminalManagementApi.java @@ -1,6 +1,5 @@ /* * POS Terminal Management API - * This API provides endpoints for managing your point-of-sale (POS) payment terminals. You can use the API to obtain information about a specific terminal, retrieve overviews of your terminals and stores, and assign terminals to a merchant account or store. For more information, refer to [Assign terminals](https://docs.adyen.com/point-of-sale/automating-terminal-management/assign-terminals-api). ## Authentication Each request to the Terminal Management API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). Then set this key to the `X-API-Key` header value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: Your_API_key\" \\ ... ``` Note that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). ## Versioning Terminal Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://postfmapi-test.adyen.com/postfmapi/terminal/v1/getTerminalsUnderAccount ``` When using versioned endpoints, Boolean response values are returned in string format: `\"true\"` or `\"false\"`. If you omit the version from the endpoint URL, Boolean response values are returned like this: `true` or `false`. * * The version of the OpenAPI document: 1 * @@ -33,7 +32,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class PosTerminalManagementApi extends Service { public static final String API_VERSION = "1"; @@ -41,7 +39,7 @@ public class PosTerminalManagementApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public PosTerminalManagementApi(Client client) { @@ -50,7 +48,7 @@ public PosTerminalManagementApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/RecurringApi.java b/src/main/java/com/adyen/service/RecurringApi.java index 75101dd87..36fd7c87b 100644 --- a/src/main/java/com/adyen/service/RecurringApi.java +++ b/src/main/java/com/adyen/service/RecurringApi.java @@ -1,6 +1,5 @@ /* * Adyen Recurring API - * The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request. For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). ## Authentication You need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API. If using an API key, add an `X-API-Key` header with the API key as the value, for example: ``` curl -H \"Content-Type: application/json\" \\ -H \"X-API-Key: YOUR_API_KEY\" \\ ... ``` Alternatively, you can use the username and password to connect to the API using basic authentication, for example: ``` curl -U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\ -H \"Content-Type: application/json\" \\ ... ``` ## Versioning Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number. For example: ``` https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable ``` ## Going live To authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area. The live endpoint URLs contain a prefix which is unique to your company account: ``` https://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable ``` Get your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**. * * The version of the OpenAPI document: 68 * @@ -35,7 +34,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class RecurringApi extends Service { public static final String API_VERSION = "68"; @@ -43,7 +41,7 @@ public class RecurringApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public RecurringApi(Client client) { @@ -52,7 +50,7 @@ public RecurringApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/StoredValueApi.java b/src/main/java/com/adyen/service/StoredValueApi.java index a95256bff..743da88be 100644 --- a/src/main/java/com/adyen/service/StoredValueApi.java +++ b/src/main/java/com/adyen/service/StoredValueApi.java @@ -1,6 +1,5 @@ /* * Adyen Stored Value API - * A set of API endpoints to manage stored value products. * * The version of the OpenAPI document: 46 * @@ -35,7 +34,6 @@ import java.io.IOException; import java.util.HashMap; import java.util.Map; - public class StoredValueApi extends Service { public static final String API_VERSION = "46"; @@ -43,7 +41,7 @@ public class StoredValueApi extends Service { protected String baseURL; /** - * General constructor in {@link com.adyen.service package}. + * Default constructor in {@link com.adyen.service package}. * @param client {@link Client } (required) */ public StoredValueApi(Client client) { @@ -52,7 +50,7 @@ public StoredValueApi(Client client) { } /** - * General constructor in {@link com.adyen.service package}. + * Alternative constructor in {@link com.adyen.service package}. * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. * @param client {@link Client } (required) * @param baseURL {@link String } (required) diff --git a/src/main/java/com/adyen/service/balanceplatform/AccountHoldersApi.java b/src/main/java/com/adyen/service/balanceplatform/AccountHoldersApi.java index bf1c82a79..3024a1543 100644 --- a/src/main/java/com/adyen/service/balanceplatform/AccountHoldersApi.java +++ b/src/main/java/com/adyen/service/balanceplatform/AccountHoldersApi.java @@ -54,6 +54,33 @@ public AccountHoldersApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Create an account holder + * + * @param accountHolderInfo {@link AccountHolderInfo } (required) + * @return {@link AccountHolder } + * @throws ApiException if fails to make API call + */ + public AccountHolder createAccountHolder(AccountHolderInfo accountHolderInfo) throws ApiException, IOException { + return createAccountHolder(accountHolderInfo, null); + } + + /** + * Create an account holder + * + * @param accountHolderInfo {@link AccountHolderInfo } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link AccountHolder } + * @throws ApiException if fails to make API call + */ + public AccountHolder createAccountHolder(AccountHolderInfo accountHolderInfo, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = accountHolderInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/accountHolders", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return AccountHolder.fromJson(jsonResult); + } + /** * Get an account holder * @@ -209,31 +236,4 @@ public AccountHolder updateAccountHolder(String id, AccountHolderUpdateRequest a String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return AccountHolder.fromJson(jsonResult); } - - /** - * Create an account holder - * - * @param accountHolderInfo {@link AccountHolderInfo } (required) - * @return {@link AccountHolder } - * @throws ApiException if fails to make API call - */ - public AccountHolder createAccountHolder(AccountHolderInfo accountHolderInfo) throws ApiException, IOException { - return createAccountHolder(accountHolderInfo, null); - } - - /** - * Create an account holder - * - * @param accountHolderInfo {@link AccountHolderInfo } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AccountHolder } - * @throws ApiException if fails to make API call - */ - public AccountHolder createAccountHolder(AccountHolderInfo accountHolderInfo, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = accountHolderInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/accountHolders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return AccountHolder.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/balanceplatform/BalanceAccountsApi.java b/src/main/java/com/adyen/service/balanceplatform/BalanceAccountsApi.java index 337c335e4..5b720f61b 100644 --- a/src/main/java/com/adyen/service/balanceplatform/BalanceAccountsApi.java +++ b/src/main/java/com/adyen/service/balanceplatform/BalanceAccountsApi.java @@ -57,6 +57,68 @@ public BalanceAccountsApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Create a balance account + * + * @param balanceAccountInfo {@link BalanceAccountInfo } (required) + * @return {@link BalanceAccount } + * @throws ApiException if fails to make API call + */ + public BalanceAccount createBalanceAccount(BalanceAccountInfo balanceAccountInfo) throws ApiException, IOException { + return createBalanceAccount(balanceAccountInfo, null); + } + + /** + * Create a balance account + * + * @param balanceAccountInfo {@link BalanceAccountInfo } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link BalanceAccount } + * @throws ApiException if fails to make API call + */ + public BalanceAccount createBalanceAccount(BalanceAccountInfo balanceAccountInfo, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = balanceAccountInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/balanceAccounts", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return BalanceAccount.fromJson(jsonResult); + } + + /** + * Create a sweep + * + * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) + * @param createSweepConfigurationV2 {@link CreateSweepConfigurationV2 } (required) + * @return {@link SweepConfigurationV2 } + * @throws ApiException if fails to make API call + */ + public SweepConfigurationV2 createSweep(String balanceAccountId, CreateSweepConfigurationV2 createSweepConfigurationV2) throws ApiException, IOException { + return createSweep(balanceAccountId, createSweepConfigurationV2, null); + } + + /** + * Create a sweep + * + * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) + * @param createSweepConfigurationV2 {@link CreateSweepConfigurationV2 } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link SweepConfigurationV2 } + * @throws ApiException if fails to make API call + */ + public SweepConfigurationV2 createSweep(String balanceAccountId, CreateSweepConfigurationV2 createSweepConfigurationV2, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (balanceAccountId == null) { + throw new IllegalArgumentException("Please provide the balanceAccountId path parameter"); + } + pathParams.put("balanceAccountId", balanceAccountId); + + String requestBody = createSweepConfigurationV2.toJson(); + Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return SweepConfigurationV2.fromJson(jsonResult); + } + /** * Delete a sweep * @@ -94,33 +156,33 @@ public void deleteSweep(String balanceAccountId, String sweepId, RequestOptions } /** - * Get all sweeps for a balance account + * Get all payment instruments for a balance account * - * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) - * @return {@link BalanceSweepConfigurationsResponse } + * @param id {@link String } The unique identifier of the balance account. (required) + * @return {@link PaginatedPaymentInstrumentsResponse } * @throws ApiException if fails to make API call */ - public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String balanceAccountId) throws ApiException, IOException { - return getAllSweepsForBalanceAccount(balanceAccountId, null, null, null); + public PaginatedPaymentInstrumentsResponse getAllPaymentInstrumentsForBalanceAccount(String id) throws ApiException, IOException { + return getAllPaymentInstrumentsForBalanceAccount(id, null, null, null); } /** - * Get all sweeps for a balance account + * Get all payment instruments for a balance account * - * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) + * @param id {@link String } The unique identifier of the balance account. (required) * @param offset {@link Integer } Query: The number of items that you want to skip. (optional) * @param limit {@link Integer } Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BalanceSweepConfigurationsResponse } + * @return {@link PaginatedPaymentInstrumentsResponse } * @throws ApiException if fails to make API call */ - public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String balanceAccountId, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public PaginatedPaymentInstrumentsResponse getAllPaymentInstrumentsForBalanceAccount(String id, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); - if (balanceAccountId == null) { - throw new IllegalArgumentException("Please provide the balanceAccountId path parameter"); + if (id == null) { + throw new IllegalArgumentException("Please provide the id path parameter"); } - pathParams.put("balanceAccountId", balanceAccountId); + pathParams.put("id", id); //Add query params Map queryParams = new HashMap<>(); if (offset != null) { @@ -131,48 +193,52 @@ public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String b } String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps", null); + Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{id}/paymentInstruments", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return BalanceSweepConfigurationsResponse.fromJson(jsonResult); + return PaginatedPaymentInstrumentsResponse.fromJson(jsonResult); } /** - * Get a sweep + * Get all sweeps for a balance account * * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) - * @param sweepId {@link String } The unique identifier of the sweep. (required) - * @return {@link SweepConfigurationV2 } + * @return {@link BalanceSweepConfigurationsResponse } * @throws ApiException if fails to make API call */ - public SweepConfigurationV2 getSweep(String balanceAccountId, String sweepId) throws ApiException, IOException { - return getSweep(balanceAccountId, sweepId, null); + public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String balanceAccountId) throws ApiException, IOException { + return getAllSweepsForBalanceAccount(balanceAccountId, null, null, null); } /** - * Get a sweep + * Get all sweeps for a balance account * * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) - * @param sweepId {@link String } The unique identifier of the sweep. (required) + * @param offset {@link Integer } Query: The number of items that you want to skip. (optional) + * @param limit {@link Integer } Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link SweepConfigurationV2 } + * @return {@link BalanceSweepConfigurationsResponse } * @throws ApiException if fails to make API call */ - public SweepConfigurationV2 getSweep(String balanceAccountId, String sweepId, RequestOptions requestOptions) throws ApiException, IOException { + public BalanceSweepConfigurationsResponse getAllSweepsForBalanceAccount(String balanceAccountId, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (balanceAccountId == null) { throw new IllegalArgumentException("Please provide the balanceAccountId path parameter"); } pathParams.put("balanceAccountId", balanceAccountId); - if (sweepId == null) { - throw new IllegalArgumentException("Please provide the sweepId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (offset != null) { + queryParams.put("offset", offset.toString()); + } + if (limit != null) { + queryParams.put("limit", limit.toString()); } - pathParams.put("sweepId", sweepId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return SweepConfigurationV2.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return BalanceSweepConfigurationsResponse.fromJson(jsonResult); } /** @@ -209,72 +275,27 @@ public BalanceAccount getBalanceAccount(String id, RequestOptions requestOptions } /** - * Get all payment instruments for a balance account - * - * @param id {@link String } The unique identifier of the balance account. (required) - * @return {@link PaginatedPaymentInstrumentsResponse } - * @throws ApiException if fails to make API call - */ - public PaginatedPaymentInstrumentsResponse getAllPaymentInstrumentsForBalanceAccount(String id) throws ApiException, IOException { - return getAllPaymentInstrumentsForBalanceAccount(id, null, null, null); - } - - /** - * Get all payment instruments for a balance account - * - * @param id {@link String } The unique identifier of the balance account. (required) - * @param offset {@link Integer } Query: The number of items that you want to skip. (optional) - * @param limit {@link Integer } Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PaginatedPaymentInstrumentsResponse } - * @throws ApiException if fails to make API call - */ - public PaginatedPaymentInstrumentsResponse getAllPaymentInstrumentsForBalanceAccount(String id, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); - //Add query params - Map queryParams = new HashMap<>(); - if (offset != null) { - queryParams.put("offset", offset.toString()); - } - if (limit != null) { - queryParams.put("limit", limit.toString()); - } - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{id}/paymentInstruments", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return PaginatedPaymentInstrumentsResponse.fromJson(jsonResult); - } - - /** - * Update a sweep + * Get a sweep * * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) * @param sweepId {@link String } The unique identifier of the sweep. (required) - * @param updateSweepConfigurationV2 {@link UpdateSweepConfigurationV2 } (required) * @return {@link SweepConfigurationV2 } * @throws ApiException if fails to make API call */ - public SweepConfigurationV2 updateSweep(String balanceAccountId, String sweepId, UpdateSweepConfigurationV2 updateSweepConfigurationV2) throws ApiException, IOException { - return updateSweep(balanceAccountId, sweepId, updateSweepConfigurationV2, null); + public SweepConfigurationV2 getSweep(String balanceAccountId, String sweepId) throws ApiException, IOException { + return getSweep(balanceAccountId, sweepId, null); } /** - * Update a sweep + * Get a sweep * * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) * @param sweepId {@link String } The unique identifier of the sweep. (required) - * @param updateSweepConfigurationV2 {@link UpdateSweepConfigurationV2 } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link SweepConfigurationV2 } * @throws ApiException if fails to make API call */ - public SweepConfigurationV2 updateSweep(String balanceAccountId, String sweepId, UpdateSweepConfigurationV2 updateSweepConfigurationV2, RequestOptions requestOptions) throws ApiException, IOException { + public SweepConfigurationV2 getSweep(String balanceAccountId, String sweepId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (balanceAccountId == null) { @@ -286,9 +307,9 @@ public SweepConfigurationV2 updateSweep(String balanceAccountId, String sweepId, } pathParams.put("sweepId", sweepId); - String requestBody = updateSweepConfigurationV2.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); return SweepConfigurationV2.fromJson(jsonResult); } @@ -328,64 +349,43 @@ public BalanceAccount updateBalanceAccount(String id, BalanceAccountUpdateReques } /** - * Create a balance account - * - * @param balanceAccountInfo {@link BalanceAccountInfo } (required) - * @return {@link BalanceAccount } - * @throws ApiException if fails to make API call - */ - public BalanceAccount createBalanceAccount(BalanceAccountInfo balanceAccountInfo) throws ApiException, IOException { - return createBalanceAccount(balanceAccountInfo, null); - } - - /** - * Create a balance account - * - * @param balanceAccountInfo {@link BalanceAccountInfo } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BalanceAccount } - * @throws ApiException if fails to make API call - */ - public BalanceAccount createBalanceAccount(BalanceAccountInfo balanceAccountInfo, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = balanceAccountInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/balanceAccounts", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return BalanceAccount.fromJson(jsonResult); - } - - /** - * Create a sweep + * Update a sweep * * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) - * @param createSweepConfigurationV2 {@link CreateSweepConfigurationV2 } (required) + * @param sweepId {@link String } The unique identifier of the sweep. (required) + * @param updateSweepConfigurationV2 {@link UpdateSweepConfigurationV2 } (required) * @return {@link SweepConfigurationV2 } * @throws ApiException if fails to make API call */ - public SweepConfigurationV2 createSweep(String balanceAccountId, CreateSweepConfigurationV2 createSweepConfigurationV2) throws ApiException, IOException { - return createSweep(balanceAccountId, createSweepConfigurationV2, null); + public SweepConfigurationV2 updateSweep(String balanceAccountId, String sweepId, UpdateSweepConfigurationV2 updateSweepConfigurationV2) throws ApiException, IOException { + return updateSweep(balanceAccountId, sweepId, updateSweepConfigurationV2, null); } /** - * Create a sweep + * Update a sweep * * @param balanceAccountId {@link String } The unique identifier of the balance account. (required) - * @param createSweepConfigurationV2 {@link CreateSweepConfigurationV2 } (required) + * @param sweepId {@link String } The unique identifier of the sweep. (required) + * @param updateSweepConfigurationV2 {@link UpdateSweepConfigurationV2 } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link SweepConfigurationV2 } * @throws ApiException if fails to make API call */ - public SweepConfigurationV2 createSweep(String balanceAccountId, CreateSweepConfigurationV2 createSweepConfigurationV2, RequestOptions requestOptions) throws ApiException, IOException { + public SweepConfigurationV2 updateSweep(String balanceAccountId, String sweepId, UpdateSweepConfigurationV2 updateSweepConfigurationV2, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (balanceAccountId == null) { throw new IllegalArgumentException("Please provide the balanceAccountId path parameter"); } pathParams.put("balanceAccountId", balanceAccountId); + if (sweepId == null) { + throw new IllegalArgumentException("Please provide the sweepId path parameter"); + } + pathParams.put("sweepId", sweepId); - String requestBody = createSweepConfigurationV2.toJson(); - Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String requestBody = updateSweepConfigurationV2.toJson(); + Resource resource = new Resource(this, this.baseURL + "/balanceAccounts/{balanceAccountId}/sweeps/{sweepId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return SweepConfigurationV2.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentGroupsApi.java b/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentGroupsApi.java index 7a81a366d..4631b8320 100644 --- a/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentGroupsApi.java +++ b/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentGroupsApi.java @@ -53,35 +53,29 @@ public PaymentInstrumentGroupsApi(Client client, String baseURL) { } /** - * Get a payment instrument group + * Create a payment instrument group * - * @param id {@link String } The unique identifier of the payment instrument group. (required) + * @param paymentInstrumentGroupInfo {@link PaymentInstrumentGroupInfo } (required) * @return {@link PaymentInstrumentGroup } * @throws ApiException if fails to make API call */ - public PaymentInstrumentGroup getPaymentInstrumentGroup(String id) throws ApiException, IOException { - return getPaymentInstrumentGroup(id, null); + public PaymentInstrumentGroup createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo) throws ApiException, IOException { + return createPaymentInstrumentGroup(paymentInstrumentGroupInfo, null); } /** - * Get a payment instrument group + * Create a payment instrument group * - * @param id {@link String } The unique identifier of the payment instrument group. (required) + * @param paymentInstrumentGroupInfo {@link PaymentInstrumentGroupInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link PaymentInstrumentGroup } * @throws ApiException if fails to make API call */ - public PaymentInstrumentGroup getPaymentInstrumentGroup(String id, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); + public PaymentInstrumentGroup createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo, RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/paymentInstrumentGroups/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + String requestBody = paymentInstrumentGroupInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/paymentInstrumentGroups", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); return PaymentInstrumentGroup.fromJson(jsonResult); } @@ -119,29 +113,35 @@ public TransactionRulesResponse getAllTransactionRulesForPaymentInstrumentGroup( } /** - * Create a payment instrument group + * Get a payment instrument group * - * @param paymentInstrumentGroupInfo {@link PaymentInstrumentGroupInfo } (required) + * @param id {@link String } The unique identifier of the payment instrument group. (required) * @return {@link PaymentInstrumentGroup } * @throws ApiException if fails to make API call */ - public PaymentInstrumentGroup createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo) throws ApiException, IOException { - return createPaymentInstrumentGroup(paymentInstrumentGroupInfo, null); + public PaymentInstrumentGroup getPaymentInstrumentGroup(String id) throws ApiException, IOException { + return getPaymentInstrumentGroup(id, null); } /** - * Create a payment instrument group + * Get a payment instrument group * - * @param paymentInstrumentGroupInfo {@link PaymentInstrumentGroupInfo } (required) + * @param id {@link String } The unique identifier of the payment instrument group. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link PaymentInstrumentGroup } * @throws ApiException if fails to make API call */ - public PaymentInstrumentGroup createPaymentInstrumentGroup(PaymentInstrumentGroupInfo paymentInstrumentGroupInfo, RequestOptions requestOptions) throws ApiException, IOException { + public PaymentInstrumentGroup getPaymentInstrumentGroup(String id, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (id == null) { + throw new IllegalArgumentException("Please provide the id path parameter"); + } + pathParams.put("id", id); - String requestBody = paymentInstrumentGroupInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/paymentInstrumentGroups", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/paymentInstrumentGroups/{id}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); return PaymentInstrumentGroup.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentsApi.java b/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentsApi.java index 79e9149c9..5b42e1140 100644 --- a/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentsApi.java +++ b/src/main/java/com/adyen/service/balanceplatform/PaymentInstrumentsApi.java @@ -57,58 +57,52 @@ public PaymentInstrumentsApi(Client client, String baseURL) { } /** - * Get a payment instrument + * Create a payment instrument * - * @param id {@link String } The unique identifier of the payment instrument. (required) + * @param paymentInstrumentInfo {@link PaymentInstrumentInfo } (required) * @return {@link PaymentInstrument } * @throws ApiException if fails to make API call */ - public PaymentInstrument getPaymentInstrument(String id) throws ApiException, IOException { - return getPaymentInstrument(id, null); + public PaymentInstrument createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo) throws ApiException, IOException { + return createPaymentInstrument(paymentInstrumentInfo, null); } /** - * Get a payment instrument + * Create a payment instrument * - * @param id {@link String } The unique identifier of the payment instrument. (required) + * @param paymentInstrumentInfo {@link PaymentInstrumentInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link PaymentInstrument } * @throws ApiException if fails to make API call */ - public PaymentInstrument getPaymentInstrument(String id, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); + public PaymentInstrument createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo, RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + String requestBody = paymentInstrumentInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/paymentInstruments", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); return PaymentInstrument.fromJson(jsonResult); } /** - * List network tokens + * Get all transaction rules for a payment instrument * * @param id {@link String } The unique identifier of the payment instrument. (required) - * @return {@link ListNetworkTokensResponse } + * @return {@link TransactionRulesResponse } * @throws ApiException if fails to make API call */ - public ListNetworkTokensResponse listNetworkTokens(String id) throws ApiException, IOException { - return listNetworkTokens(id, null); + public TransactionRulesResponse getAllTransactionRulesForPaymentInstrument(String id) throws ApiException, IOException { + return getAllTransactionRulesForPaymentInstrument(id, null); } /** - * List network tokens + * Get all transaction rules for a payment instrument * * @param id {@link String } The unique identifier of the payment instrument. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListNetworkTokensResponse } + * @return {@link TransactionRulesResponse } * @throws ApiException if fails to make API call */ - public ListNetworkTokensResponse listNetworkTokens(String id, RequestOptions requestOptions) throws ApiException, IOException { + public TransactionRulesResponse getAllTransactionRulesForPaymentInstrument(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -117,9 +111,9 @@ public ListNetworkTokensResponse listNetworkTokens(String id, RequestOptions req pathParams.put("id", id); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}/networkTokens", null); + Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}/transactionRules", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return ListNetworkTokensResponse.fromJson(jsonResult); + return TransactionRulesResponse.fromJson(jsonResult); } /** @@ -156,25 +150,25 @@ public PaymentInstrumentRevealInfo getPanOfPaymentInstrument(String id, RequestO } /** - * Get all transaction rules for a payment instrument + * Get a payment instrument * * @param id {@link String } The unique identifier of the payment instrument. (required) - * @return {@link TransactionRulesResponse } + * @return {@link PaymentInstrument } * @throws ApiException if fails to make API call */ - public TransactionRulesResponse getAllTransactionRulesForPaymentInstrument(String id) throws ApiException, IOException { - return getAllTransactionRulesForPaymentInstrument(id, null); + public PaymentInstrument getPaymentInstrument(String id) throws ApiException, IOException { + return getPaymentInstrument(id, null); } /** - * Get all transaction rules for a payment instrument + * Get a payment instrument * * @param id {@link String } The unique identifier of the payment instrument. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TransactionRulesResponse } + * @return {@link PaymentInstrument } * @throws ApiException if fails to make API call */ - public TransactionRulesResponse getAllTransactionRulesForPaymentInstrument(String id, RequestOptions requestOptions) throws ApiException, IOException { + public PaymentInstrument getPaymentInstrument(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -183,33 +177,31 @@ public TransactionRulesResponse getAllTransactionRulesForPaymentInstrument(Strin pathParams.put("id", id); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}/transactionRules", null); + Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return TransactionRulesResponse.fromJson(jsonResult); + return PaymentInstrument.fromJson(jsonResult); } /** - * Update a payment instrument + * List network tokens * * @param id {@link String } The unique identifier of the payment instrument. (required) - * @param paymentInstrumentUpdateRequest {@link PaymentInstrumentUpdateRequest } (required) - * @return {@link UpdatePaymentInstrument } + * @return {@link ListNetworkTokensResponse } * @throws ApiException if fails to make API call */ - public UpdatePaymentInstrument updatePaymentInstrument(String id, PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest) throws ApiException, IOException { - return updatePaymentInstrument(id, paymentInstrumentUpdateRequest, null); + public ListNetworkTokensResponse listNetworkTokens(String id) throws ApiException, IOException { + return listNetworkTokens(id, null); } /** - * Update a payment instrument + * List network tokens * * @param id {@link String } The unique identifier of the payment instrument. (required) - * @param paymentInstrumentUpdateRequest {@link PaymentInstrumentUpdateRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link UpdatePaymentInstrument } + * @return {@link ListNetworkTokensResponse } * @throws ApiException if fails to make API call */ - public UpdatePaymentInstrument updatePaymentInstrument(String id, PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ListNetworkTokensResponse listNetworkTokens(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -217,36 +209,44 @@ public UpdatePaymentInstrument updatePaymentInstrument(String id, PaymentInstrum } pathParams.put("id", id); - String requestBody = paymentInstrumentUpdateRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return UpdatePaymentInstrument.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}/networkTokens", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return ListNetworkTokensResponse.fromJson(jsonResult); } /** - * Create a payment instrument + * Update a payment instrument * - * @param paymentInstrumentInfo {@link PaymentInstrumentInfo } (required) - * @return {@link PaymentInstrument } + * @param id {@link String } The unique identifier of the payment instrument. (required) + * @param paymentInstrumentUpdateRequest {@link PaymentInstrumentUpdateRequest } (required) + * @return {@link UpdatePaymentInstrument } * @throws ApiException if fails to make API call */ - public PaymentInstrument createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo) throws ApiException, IOException { - return createPaymentInstrument(paymentInstrumentInfo, null); + public UpdatePaymentInstrument updatePaymentInstrument(String id, PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest) throws ApiException, IOException { + return updatePaymentInstrument(id, paymentInstrumentUpdateRequest, null); } /** - * Create a payment instrument + * Update a payment instrument * - * @param paymentInstrumentInfo {@link PaymentInstrumentInfo } (required) + * @param id {@link String } The unique identifier of the payment instrument. (required) + * @param paymentInstrumentUpdateRequest {@link PaymentInstrumentUpdateRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PaymentInstrument } + * @return {@link UpdatePaymentInstrument } * @throws ApiException if fails to make API call */ - public PaymentInstrument createPaymentInstrument(PaymentInstrumentInfo paymentInstrumentInfo, RequestOptions requestOptions) throws ApiException, IOException { + public UpdatePaymentInstrument updatePaymentInstrument(String id, PaymentInstrumentUpdateRequest paymentInstrumentUpdateRequest, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (id == null) { + throw new IllegalArgumentException("Please provide the id path parameter"); + } + pathParams.put("id", id); - String requestBody = paymentInstrumentInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/paymentInstruments", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return PaymentInstrument.fromJson(jsonResult); + String requestBody = paymentInstrumentUpdateRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/paymentInstruments/{id}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return UpdatePaymentInstrument.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/balanceplatform/PlatformApi.java b/src/main/java/com/adyen/service/balanceplatform/PlatformApi.java index df1e818fb..b8d4abaee 100644 --- a/src/main/java/com/adyen/service/balanceplatform/PlatformApi.java +++ b/src/main/java/com/adyen/service/balanceplatform/PlatformApi.java @@ -52,78 +52,78 @@ public PlatformApi(Client client, String baseURL) { } /** - * Get a balance platform + * Get all account holders under a balance platform * * @param id {@link String } The unique identifier of the balance platform. (required) - * @return {@link BalancePlatform } + * @return {@link PaginatedAccountHoldersResponse } * @throws ApiException if fails to make API call */ - public BalancePlatform getBalancePlatform(String id) throws ApiException, IOException { - return getBalancePlatform(id, null); + public PaginatedAccountHoldersResponse getAllAccountHoldersUnderBalancePlatform(String id) throws ApiException, IOException { + return getAllAccountHoldersUnderBalancePlatform(id, null, null, null); } /** - * Get a balance platform + * Get all account holders under a balance platform * * @param id {@link String } The unique identifier of the balance platform. (required) + * @param offset {@link Integer } Query: The number of items that you want to skip. (optional) + * @param limit {@link Integer } Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BalancePlatform } + * @return {@link PaginatedAccountHoldersResponse } * @throws ApiException if fails to make API call */ - public BalancePlatform getBalancePlatform(String id, RequestOptions requestOptions) throws ApiException, IOException { + public PaginatedAccountHoldersResponse getAllAccountHoldersUnderBalancePlatform(String id, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { throw new IllegalArgumentException("Please provide the id path parameter"); } pathParams.put("id", id); + //Add query params + Map queryParams = new HashMap<>(); + if (offset != null) { + queryParams.put("offset", offset.toString()); + } + if (limit != null) { + queryParams.put("limit", limit.toString()); + } String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/balancePlatforms/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return BalancePlatform.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/balancePlatforms/{id}/accountHolders", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return PaginatedAccountHoldersResponse.fromJson(jsonResult); } /** - * Get all account holders under a balance platform + * Get a balance platform * * @param id {@link String } The unique identifier of the balance platform. (required) - * @return {@link PaginatedAccountHoldersResponse } + * @return {@link BalancePlatform } * @throws ApiException if fails to make API call */ - public PaginatedAccountHoldersResponse getAllAccountHoldersUnderBalancePlatform(String id) throws ApiException, IOException { - return getAllAccountHoldersUnderBalancePlatform(id, null, null, null); + public BalancePlatform getBalancePlatform(String id) throws ApiException, IOException { + return getBalancePlatform(id, null); } /** - * Get all account holders under a balance platform + * Get a balance platform * * @param id {@link String } The unique identifier of the balance platform. (required) - * @param offset {@link Integer } Query: The number of items that you want to skip. (optional) - * @param limit {@link Integer } Query: The number of items returned per page, maximum 100 items. By default, the response returns 10 items per page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PaginatedAccountHoldersResponse } + * @return {@link BalancePlatform } * @throws ApiException if fails to make API call */ - public PaginatedAccountHoldersResponse getAllAccountHoldersUnderBalancePlatform(String id, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public BalancePlatform getBalancePlatform(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { throw new IllegalArgumentException("Please provide the id path parameter"); } pathParams.put("id", id); - //Add query params - Map queryParams = new HashMap<>(); - if (offset != null) { - queryParams.put("offset", offset.toString()); - } - if (limit != null) { - queryParams.put("limit", limit.toString()); - } String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/balancePlatforms/{id}/accountHolders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return PaginatedAccountHoldersResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/balancePlatforms/{id}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return BalancePlatform.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/balanceplatform/TransactionRulesApi.java b/src/main/java/com/adyen/service/balanceplatform/TransactionRulesApi.java index 651885925..9954906a0 100644 --- a/src/main/java/com/adyen/service/balanceplatform/TransactionRulesApi.java +++ b/src/main/java/com/adyen/service/balanceplatform/TransactionRulesApi.java @@ -52,6 +52,33 @@ public TransactionRulesApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Create a transaction rule + * + * @param transactionRuleInfo {@link TransactionRuleInfo } (required) + * @return {@link TransactionRule } + * @throws ApiException if fails to make API call + */ + public TransactionRule createTransactionRule(TransactionRuleInfo transactionRuleInfo) throws ApiException, IOException { + return createTransactionRule(transactionRuleInfo, null); + } + + /** + * Create a transaction rule + * + * @param transactionRuleInfo {@link TransactionRuleInfo } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link TransactionRule } + * @throws ApiException if fails to make API call + */ + public TransactionRule createTransactionRule(TransactionRuleInfo transactionRuleInfo, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = transactionRuleInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/transactionRules", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return TransactionRule.fromJson(jsonResult); + } + /** * Delete a transaction rule * @@ -152,31 +179,4 @@ public TransactionRule updateTransactionRule(String transactionRuleId, Transacti String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return TransactionRule.fromJson(jsonResult); } - - /** - * Create a transaction rule - * - * @param transactionRuleInfo {@link TransactionRuleInfo } (required) - * @return {@link TransactionRule } - * @throws ApiException if fails to make API call - */ - public TransactionRule createTransactionRule(TransactionRuleInfo transactionRuleInfo) throws ApiException, IOException { - return createTransactionRule(transactionRuleInfo, null); - } - - /** - * Create a transaction rule - * - * @param transactionRuleInfo {@link TransactionRuleInfo } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TransactionRule } - * @throws ApiException if fails to make API call - */ - public TransactionRule createTransactionRule(TransactionRuleInfo transactionRuleInfo, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = transactionRuleInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/transactionRules", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return TransactionRule.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/checkout/DonationsApi.java b/src/main/java/com/adyen/service/checkout/DonationsApi.java new file mode 100644 index 000000000..94cad950a --- /dev/null +++ b/src/main/java/com/adyen/service/checkout/DonationsApi.java @@ -0,0 +1,80 @@ +/* + * Adyen Checkout API + * + * The version of the OpenAPI document: 71 + * + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package com.adyen.service.checkout; + +import com.adyen.Client; +import com.adyen.Service; +import com.adyen.constants.ApiConstants; +import com.adyen.model.checkout.DonationPaymentRequest; +import com.adyen.model.checkout.DonationPaymentResponse; +import com.adyen.model.checkout.ServiceError; +import com.adyen.model.RequestOptions; +import com.adyen.service.exception.ApiException; +import com.adyen.service.resource.Resource; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; + +public class DonationsApi extends Service { + + public static final String API_VERSION = "71"; + + protected String baseURL; + + /** + * Donations constructor in {@link com.adyen.service.checkout package}. + * @param client {@link Client } (required) + */ + public DonationsApi(Client client) { + super(client); + this.baseURL = createBaseURL("https://checkout-test.adyen.com/v71"); + } + + /** + * Donations constructor in {@link com.adyen.service.checkout package}. + * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant. + * @param client {@link Client } (required) + * @param baseURL {@link String } (required) + */ + public DonationsApi(Client client, String baseURL) { + super(client); + this.baseURL = baseURL; + } + + /** + * Start a transaction for donations + * + * @param donationPaymentRequest {@link DonationPaymentRequest } (required) + * @return {@link DonationPaymentResponse } + * @throws ApiException if fails to make API call + */ + public DonationPaymentResponse donations(DonationPaymentRequest donationPaymentRequest) throws ApiException, IOException { + return donations(donationPaymentRequest, null); + } + + /** + * Start a transaction for donations + * + * @param donationPaymentRequest {@link DonationPaymentRequest } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link DonationPaymentResponse } + * @throws ApiException if fails to make API call + */ + public DonationPaymentResponse donations(DonationPaymentRequest donationPaymentRequest, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = donationPaymentRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/donations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return DonationPaymentResponse.fromJson(jsonResult); + } +} diff --git a/src/main/java/com/adyen/service/checkout/ModificationsApi.java b/src/main/java/com/adyen/service/checkout/ModificationsApi.java index eda72b444..7c1538482 100644 --- a/src/main/java/com/adyen/service/checkout/ModificationsApi.java +++ b/src/main/java/com/adyen/service/checkout/ModificationsApi.java @@ -88,41 +88,6 @@ public StandalonePaymentCancelResponse cancelAuthorisedPayment(StandalonePayment return StandalonePaymentCancelResponse.fromJson(jsonResult); } - /** - * Update an authorised amount - * - * @param paymentPspReference {@link String } The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment. (required) - * @param paymentAmountUpdateRequest {@link PaymentAmountUpdateRequest } (required) - * @return {@link PaymentAmountUpdateResponse } - * @throws ApiException if fails to make API call - */ - public PaymentAmountUpdateResponse updateAuthorisedAmount(String paymentPspReference, PaymentAmountUpdateRequest paymentAmountUpdateRequest) throws ApiException, IOException { - return updateAuthorisedAmount(paymentPspReference, paymentAmountUpdateRequest, null); - } - - /** - * Update an authorised amount - * - * @param paymentPspReference {@link String } The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment. (required) - * @param paymentAmountUpdateRequest {@link PaymentAmountUpdateRequest } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PaymentAmountUpdateResponse } - * @throws ApiException if fails to make API call - */ - public PaymentAmountUpdateResponse updateAuthorisedAmount(String paymentPspReference, PaymentAmountUpdateRequest paymentAmountUpdateRequest, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (paymentPspReference == null) { - throw new IllegalArgumentException("Please provide the paymentPspReference path parameter"); - } - pathParams.put("paymentPspReference", paymentPspReference); - - String requestBody = paymentAmountUpdateRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/payments/{paymentPspReference}/amountUpdates", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return PaymentAmountUpdateResponse.fromJson(jsonResult); - } - /** * Cancel an authorised payment * @@ -262,4 +227,39 @@ public PaymentReversalResponse refundOrCancelPayment(String paymentPspReference, String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); return PaymentReversalResponse.fromJson(jsonResult); } + + /** + * Update an authorised amount + * + * @param paymentPspReference {@link String } The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment. (required) + * @param paymentAmountUpdateRequest {@link PaymentAmountUpdateRequest } (required) + * @return {@link PaymentAmountUpdateResponse } + * @throws ApiException if fails to make API call + */ + public PaymentAmountUpdateResponse updateAuthorisedAmount(String paymentPspReference, PaymentAmountUpdateRequest paymentAmountUpdateRequest) throws ApiException, IOException { + return updateAuthorisedAmount(paymentPspReference, paymentAmountUpdateRequest, null); + } + + /** + * Update an authorised amount + * + * @param paymentPspReference {@link String } The [`pspReference`](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments__resParam_pspReference) of the payment. (required) + * @param paymentAmountUpdateRequest {@link PaymentAmountUpdateRequest } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link PaymentAmountUpdateResponse } + * @throws ApiException if fails to make API call + */ + public PaymentAmountUpdateResponse updateAuthorisedAmount(String paymentPspReference, PaymentAmountUpdateRequest paymentAmountUpdateRequest, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (paymentPspReference == null) { + throw new IllegalArgumentException("Please provide the paymentPspReference path parameter"); + } + pathParams.put("paymentPspReference", paymentPspReference); + + String requestBody = paymentAmountUpdateRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/payments/{paymentPspReference}/amountUpdates", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return PaymentAmountUpdateResponse.fromJson(jsonResult); + } } diff --git a/src/main/java/com/adyen/service/checkout/OrdersApi.java b/src/main/java/com/adyen/service/checkout/OrdersApi.java index 6b49e35ba..5f61b79da 100644 --- a/src/main/java/com/adyen/service/checkout/OrdersApi.java +++ b/src/main/java/com/adyen/service/checkout/OrdersApi.java @@ -55,33 +55,6 @@ public OrdersApi(Client client, String baseURL) { this.baseURL = baseURL; } - /** - * Create an order - * - * @param createOrderRequest {@link CreateOrderRequest } (required) - * @return {@link CreateOrderResponse } - * @throws ApiException if fails to make API call - */ - public CreateOrderResponse orders(CreateOrderRequest createOrderRequest) throws ApiException, IOException { - return orders(createOrderRequest, null); - } - - /** - * Create an order - * - * @param createOrderRequest {@link CreateOrderRequest } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CreateOrderResponse } - * @throws ApiException if fails to make API call - */ - public CreateOrderResponse orders(CreateOrderRequest createOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = createOrderRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/orders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return CreateOrderResponse.fromJson(jsonResult); - } - /** * Cancel an order * @@ -135,4 +108,31 @@ public BalanceCheckResponse getBalanceOfGiftCard(BalanceCheckRequest balanceChec String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); return BalanceCheckResponse.fromJson(jsonResult); } + + /** + * Create an order + * + * @param createOrderRequest {@link CreateOrderRequest } (required) + * @return {@link CreateOrderResponse } + * @throws ApiException if fails to make API call + */ + public CreateOrderResponse orders(CreateOrderRequest createOrderRequest) throws ApiException, IOException { + return orders(createOrderRequest, null); + } + + /** + * Create an order + * + * @param createOrderRequest {@link CreateOrderRequest } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link CreateOrderResponse } + * @throws ApiException if fails to make API call + */ + public CreateOrderResponse orders(CreateOrderRequest createOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = createOrderRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/orders", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return CreateOrderResponse.fromJson(jsonResult); + } } diff --git a/src/main/java/com/adyen/service/checkout/PaymentLinksApi.java b/src/main/java/com/adyen/service/checkout/PaymentLinksApi.java index e0beec6a5..1afe262c4 100644 --- a/src/main/java/com/adyen/service/checkout/PaymentLinksApi.java +++ b/src/main/java/com/adyen/service/checkout/PaymentLinksApi.java @@ -85,6 +85,33 @@ public PaymentLinkResponse getPaymentLink(String linkId, RequestOptions requestO return PaymentLinkResponse.fromJson(jsonResult); } + /** + * Create a payment link + * + * @param paymentLinkRequest {@link PaymentLinkRequest } (required) + * @return {@link PaymentLinkResponse } + * @throws ApiException if fails to make API call + */ + public PaymentLinkResponse paymentLinks(PaymentLinkRequest paymentLinkRequest) throws ApiException, IOException { + return paymentLinks(paymentLinkRequest, null); + } + + /** + * Create a payment link + * + * @param paymentLinkRequest {@link PaymentLinkRequest } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link PaymentLinkResponse } + * @throws ApiException if fails to make API call + */ + public PaymentLinkResponse paymentLinks(PaymentLinkRequest paymentLinkRequest, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = paymentLinkRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/paymentLinks", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return PaymentLinkResponse.fromJson(jsonResult); + } + /** * Update the status of a payment link * @@ -119,31 +146,4 @@ public PaymentLinkResponse updatePaymentLink(String linkId, UpdatePaymentLinkReq String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return PaymentLinkResponse.fromJson(jsonResult); } - - /** - * Create a payment link - * - * @param paymentLinkRequest {@link PaymentLinkRequest } (required) - * @return {@link PaymentLinkResponse } - * @throws ApiException if fails to make API call - */ - public PaymentLinkResponse paymentLinks(PaymentLinkRequest paymentLinkRequest) throws ApiException, IOException { - return paymentLinks(paymentLinkRequest, null); - } - - /** - * Create a payment link - * - * @param paymentLinkRequest {@link PaymentLinkRequest } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PaymentLinkResponse } - * @throws ApiException if fails to make API call - */ - public PaymentLinkResponse paymentLinks(PaymentLinkRequest paymentLinkRequest, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = paymentLinkRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/paymentLinks", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return PaymentLinkResponse.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/checkout/PaymentsApi.java b/src/main/java/com/adyen/service/checkout/PaymentsApi.java index fe238e7d3..8849a29e1 100644 --- a/src/main/java/com/adyen/service/checkout/PaymentsApi.java +++ b/src/main/java/com/adyen/service/checkout/PaymentsApi.java @@ -18,8 +18,6 @@ import com.adyen.model.checkout.CardDetailsResponse; import com.adyen.model.checkout.CreateCheckoutSessionRequest; import com.adyen.model.checkout.CreateCheckoutSessionResponse; -import com.adyen.model.checkout.DonationPaymentRequest; -import com.adyen.model.checkout.DonationPaymentResponse; import com.adyen.model.checkout.PaymentDetailsRequest; import com.adyen.model.checkout.PaymentDetailsResponse; import com.adyen.model.checkout.PaymentMethodsRequest; @@ -62,46 +60,6 @@ public PaymentsApi(Client client, String baseURL) { this.baseURL = baseURL; } - /** - * Get the result of a payment session - * - * @param sessionId {@link String } A unique identifier of the session. (required) - * @param sessionResult {@link String } The `sessionResult` value from the Drop-in or Component. (required) - * @return {@link SessionResultResponse } - * @throws ApiException if fails to make API call - */ - public SessionResultResponse getResultOfPaymentSession(String sessionId, String sessionResult) throws ApiException, IOException { - return getResultOfPaymentSession(sessionId, sessionResult, null); - } - - /** - * Get the result of a payment session - * - * @param sessionId {@link String } A unique identifier of the session. (required) - * @param sessionResult {@link String } Query: The `sessionResult` value from the Drop-in or Component. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link SessionResultResponse } - * @throws ApiException if fails to make API call - */ - public SessionResultResponse getResultOfPaymentSession(String sessionId, String sessionResult, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (sessionId == null) { - throw new IllegalArgumentException("Please provide the sessionId path parameter"); - } - pathParams.put("sessionId", sessionId); - //Add query params - Map queryParams = new HashMap<>(); - if (sessionResult != null) { - queryParams.put("sessionResult", sessionResult); - } - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/sessions/{sessionId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return SessionResultResponse.fromJson(jsonResult); - } - /** * Get the list of brands on the card * @@ -130,30 +88,43 @@ public CardDetailsResponse cardDetails(CardDetailsRequest cardDetailsRequest, Re } /** - * Start a transaction for donations + * Get the result of a payment session * - * @param donationPaymentRequest {@link DonationPaymentRequest } (required) - * @return {@link DonationPaymentResponse } + * @param sessionId {@link String } A unique identifier of the session. (required) + * @param sessionResult {@link String } The `sessionResult` value from the Drop-in or Component. (required) + * @return {@link SessionResultResponse } * @throws ApiException if fails to make API call */ - public DonationPaymentResponse donations(DonationPaymentRequest donationPaymentRequest) throws ApiException, IOException { - return donations(donationPaymentRequest, null); + public SessionResultResponse getResultOfPaymentSession(String sessionId, String sessionResult) throws ApiException, IOException { + return getResultOfPaymentSession(sessionId, sessionResult, null); } /** - * Start a transaction for donations + * Get the result of a payment session * - * @param donationPaymentRequest {@link DonationPaymentRequest } (required) + * @param sessionId {@link String } A unique identifier of the session. (required) + * @param sessionResult {@link String } Query: The `sessionResult` value from the Drop-in or Component. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link DonationPaymentResponse } + * @return {@link SessionResultResponse } * @throws ApiException if fails to make API call */ - public DonationPaymentResponse donations(DonationPaymentRequest donationPaymentRequest, RequestOptions requestOptions) throws ApiException, IOException { + public SessionResultResponse getResultOfPaymentSession(String sessionId, String sessionResult, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (sessionId == null) { + throw new IllegalArgumentException("Please provide the sessionId path parameter"); + } + pathParams.put("sessionId", sessionId); + //Add query params + Map queryParams = new HashMap<>(); + if (sessionResult != null) { + queryParams.put("sessionResult", sessionResult); + } - String requestBody = donationPaymentRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/donations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return DonationPaymentResponse.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/sessions/{sessionId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return SessionResultResponse.fromJson(jsonResult); } /** diff --git a/src/main/java/com/adyen/service/legalentitymanagement/BusinessLinesApi.java b/src/main/java/com/adyen/service/legalentitymanagement/BusinessLinesApi.java index 481d44e2b..550b73d8c 100644 --- a/src/main/java/com/adyen/service/legalentitymanagement/BusinessLinesApi.java +++ b/src/main/java/com/adyen/service/legalentitymanagement/BusinessLinesApi.java @@ -52,6 +52,33 @@ public BusinessLinesApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Create a business line + * + * @param businessLineInfo {@link BusinessLineInfo } (required) + * @return {@link BusinessLine } + * @throws ApiException if fails to make API call + */ + public BusinessLine createBusinessLine(BusinessLineInfo businessLineInfo) throws ApiException, IOException { + return createBusinessLine(businessLineInfo, null); + } + + /** + * Create a business line + * + * @param businessLineInfo {@link BusinessLineInfo } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link BusinessLine } + * @throws ApiException if fails to make API call + */ + public BusinessLine createBusinessLine(BusinessLineInfo businessLineInfo, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = businessLineInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/businessLines", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return BusinessLine.fromJson(jsonResult); + } + /** * Delete a business line * @@ -149,31 +176,4 @@ public BusinessLine updateBusinessLine(String id, BusinessLineInfoUpdate busines String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return BusinessLine.fromJson(jsonResult); } - - /** - * Create a business line - * - * @param businessLineInfo {@link BusinessLineInfo } (required) - * @return {@link BusinessLine } - * @throws ApiException if fails to make API call - */ - public BusinessLine createBusinessLine(BusinessLineInfo businessLineInfo) throws ApiException, IOException { - return createBusinessLine(businessLineInfo, null); - } - - /** - * Create a business line - * - * @param businessLineInfo {@link BusinessLineInfo } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BusinessLine } - * @throws ApiException if fails to make API call - */ - public BusinessLine createBusinessLine(BusinessLineInfo businessLineInfo, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = businessLineInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/businessLines", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return BusinessLine.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/legalentitymanagement/HostedOnboardingApi.java b/src/main/java/com/adyen/service/legalentitymanagement/HostedOnboardingApi.java index 313cc10e8..afc86e019 100644 --- a/src/main/java/com/adyen/service/legalentitymanagement/HostedOnboardingApi.java +++ b/src/main/java/com/adyen/service/legalentitymanagement/HostedOnboardingApi.java @@ -54,28 +54,38 @@ public HostedOnboardingApi(Client client, String baseURL) { } /** - * Get a list of hosted onboarding page themes + * Get a link to an Adyen-hosted onboarding page * - * @return {@link OnboardingThemes } + * @param id {@link String } The unique identifier of the legal entity (required) + * @param onboardingLinkInfo {@link OnboardingLinkInfo } (required) + * @return {@link OnboardingLink } * @throws ApiException if fails to make API call */ - public OnboardingThemes listHostedOnboardingPageThemes() throws ApiException, IOException { - return listHostedOnboardingPageThemes(null); + public OnboardingLink getLinkToAdyenhostedOnboardingPage(String id, OnboardingLinkInfo onboardingLinkInfo) throws ApiException, IOException { + return getLinkToAdyenhostedOnboardingPage(id, onboardingLinkInfo, null); } /** - * Get a list of hosted onboarding page themes + * Get a link to an Adyen-hosted onboarding page * + * @param id {@link String } The unique identifier of the legal entity (required) + * @param onboardingLinkInfo {@link OnboardingLinkInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link OnboardingThemes } + * @return {@link OnboardingLink } * @throws ApiException if fails to make API call */ - public OnboardingThemes listHostedOnboardingPageThemes(RequestOptions requestOptions) throws ApiException, IOException { + public OnboardingLink getLinkToAdyenhostedOnboardingPage(String id, OnboardingLinkInfo onboardingLinkInfo, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (id == null) { + throw new IllegalArgumentException("Please provide the id path parameter"); + } + pathParams.put("id", id); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/themes", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null); - return OnboardingThemes.fromJson(jsonResult); + String requestBody = onboardingLinkInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/onboardingLinks", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return OnboardingLink.fromJson(jsonResult); } /** @@ -112,37 +122,27 @@ public OnboardingTheme getOnboardingLinkTheme(String id, RequestOptions requestO } /** - * Get a link to an Adyen-hosted onboarding page + * Get a list of hosted onboarding page themes * - * @param id {@link String } The unique identifier of the legal entity (required) - * @param onboardingLinkInfo {@link OnboardingLinkInfo } (required) - * @return {@link OnboardingLink } + * @return {@link OnboardingThemes } * @throws ApiException if fails to make API call */ - public OnboardingLink getLinkToAdyenhostedOnboardingPage(String id, OnboardingLinkInfo onboardingLinkInfo) throws ApiException, IOException { - return getLinkToAdyenhostedOnboardingPage(id, onboardingLinkInfo, null); + public OnboardingThemes listHostedOnboardingPageThemes() throws ApiException, IOException { + return listHostedOnboardingPageThemes(null); } /** - * Get a link to an Adyen-hosted onboarding page + * Get a list of hosted onboarding page themes * - * @param id {@link String } The unique identifier of the legal entity (required) - * @param onboardingLinkInfo {@link OnboardingLinkInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link OnboardingLink } + * @return {@link OnboardingThemes } * @throws ApiException if fails to make API call */ - public OnboardingLink getLinkToAdyenhostedOnboardingPage(String id, OnboardingLinkInfo onboardingLinkInfo, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); + public OnboardingThemes listHostedOnboardingPageThemes(RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = onboardingLinkInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/onboardingLinks", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return OnboardingLink.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/themes", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null); + return OnboardingThemes.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/legalentitymanagement/LegalEntitiesApi.java b/src/main/java/com/adyen/service/legalentitymanagement/LegalEntitiesApi.java index f80b616d5..9e30ca3ed 100644 --- a/src/main/java/com/adyen/service/legalentitymanagement/LegalEntitiesApi.java +++ b/src/main/java/com/adyen/service/legalentitymanagement/LegalEntitiesApi.java @@ -56,25 +56,25 @@ public LegalEntitiesApi(Client client, String baseURL) { } /** - * Get a legal entity + * Check a legal entity's verification errors * * @param id {@link String } The unique identifier of the legal entity. (required) - * @return {@link LegalEntity } + * @return {@link VerificationErrors } * @throws ApiException if fails to make API call */ - public LegalEntity getLegalEntity(String id) throws ApiException, IOException { - return getLegalEntity(id, null); + public VerificationErrors checkLegalEntitysVerificationErrors(String id) throws ApiException, IOException { + return checkLegalEntitysVerificationErrors(id, null); } /** - * Get a legal entity + * Check a legal entity's verification errors * * @param id {@link String } The unique identifier of the legal entity. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link LegalEntity } + * @return {@link VerificationErrors } * @throws ApiException if fails to make API call */ - public LegalEntity getLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException { + public VerificationErrors checkLegalEntitysVerificationErrors(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -83,31 +83,31 @@ public LegalEntity getLegalEntity(String id, RequestOptions requestOptions) thro pathParams.put("id", id); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return LegalEntity.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/checkVerificationErrors", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return VerificationErrors.fromJson(jsonResult); } /** - * Get all business lines under a legal entity + * Confirm data review * * @param id {@link String } The unique identifier of the legal entity. (required) - * @return {@link BusinessLines } + * @return {@link DataReviewConfirmationResponse } * @throws ApiException if fails to make API call */ - public BusinessLines getAllBusinessLinesUnderLegalEntity(String id) throws ApiException, IOException { - return getAllBusinessLinesUnderLegalEntity(id, null); + public DataReviewConfirmationResponse confirmDataReview(String id) throws ApiException, IOException { + return confirmDataReview(id, null); } /** - * Get all business lines under a legal entity + * Confirm data review * * @param id {@link String } The unique identifier of the legal entity. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BusinessLines } + * @return {@link DataReviewConfirmationResponse } * @throws ApiException if fails to make API call */ - public BusinessLines getAllBusinessLinesUnderLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException { + public DataReviewConfirmationResponse confirmDataReview(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -116,93 +116,91 @@ public BusinessLines getAllBusinessLinesUnderLegalEntity(String id, RequestOptio pathParams.put("id", id); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/businessLines", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return BusinessLines.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/confirmDataReview", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return DataReviewConfirmationResponse.fromJson(jsonResult); } /** - * Update a legal entity + * Create a legal entity * - * @param id {@link String } The unique identifier of the legal entity. (required) - * @param legalEntityInfo {@link LegalEntityInfo } (required) + * @param legalEntityInfoRequiredType {@link LegalEntityInfoRequiredType } (required) * @return {@link LegalEntity } * @throws ApiException if fails to make API call */ - public LegalEntity updateLegalEntity(String id, LegalEntityInfo legalEntityInfo) throws ApiException, IOException { - return updateLegalEntity(id, legalEntityInfo, null); + public LegalEntity createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType) throws ApiException, IOException { + return createLegalEntity(legalEntityInfoRequiredType, null); } /** - * Update a legal entity + * Create a legal entity * - * @param id {@link String } The unique identifier of the legal entity. (required) - * @param legalEntityInfo {@link LegalEntityInfo } (required) + * @param legalEntityInfoRequiredType {@link LegalEntityInfoRequiredType } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link LegalEntity } * @throws ApiException if fails to make API call */ - public LegalEntity updateLegalEntity(String id, LegalEntityInfo legalEntityInfo, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); + public LegalEntity createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType, RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = legalEntityInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + String requestBody = legalEntityInfoRequiredType.toJson(); + Resource resource = new Resource(this, this.baseURL + "/legalEntities", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); return LegalEntity.fromJson(jsonResult); } /** - * Create a legal entity + * Get all business lines under a legal entity * - * @param legalEntityInfoRequiredType {@link LegalEntityInfoRequiredType } (required) - * @return {@link LegalEntity } + * @param id {@link String } The unique identifier of the legal entity. (required) + * @return {@link BusinessLines } * @throws ApiException if fails to make API call */ - public LegalEntity createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType) throws ApiException, IOException { - return createLegalEntity(legalEntityInfoRequiredType, null); + public BusinessLines getAllBusinessLinesUnderLegalEntity(String id) throws ApiException, IOException { + return getAllBusinessLinesUnderLegalEntity(id, null); } /** - * Create a legal entity + * Get all business lines under a legal entity * - * @param legalEntityInfoRequiredType {@link LegalEntityInfoRequiredType } (required) + * @param id {@link String } The unique identifier of the legal entity. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link LegalEntity } + * @return {@link BusinessLines } * @throws ApiException if fails to make API call */ - public LegalEntity createLegalEntity(LegalEntityInfoRequiredType legalEntityInfoRequiredType, RequestOptions requestOptions) throws ApiException, IOException { + public BusinessLines getAllBusinessLinesUnderLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (id == null) { + throw new IllegalArgumentException("Please provide the id path parameter"); + } + pathParams.put("id", id); - String requestBody = legalEntityInfoRequiredType.toJson(); - Resource resource = new Resource(this, this.baseURL + "/legalEntities", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return LegalEntity.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/businessLines", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return BusinessLines.fromJson(jsonResult); } /** - * Check a legal entity's verification errors + * Get a legal entity * * @param id {@link String } The unique identifier of the legal entity. (required) - * @return {@link VerificationErrors } + * @return {@link LegalEntity } * @throws ApiException if fails to make API call */ - public VerificationErrors checkLegalEntitysVerificationErrors(String id) throws ApiException, IOException { - return checkLegalEntitysVerificationErrors(id, null); + public LegalEntity getLegalEntity(String id) throws ApiException, IOException { + return getLegalEntity(id, null); } /** - * Check a legal entity's verification errors + * Get a legal entity * * @param id {@link String } The unique identifier of the legal entity. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link VerificationErrors } + * @return {@link LegalEntity } * @throws ApiException if fails to make API call */ - public VerificationErrors checkLegalEntitysVerificationErrors(String id, RequestOptions requestOptions) throws ApiException, IOException { + public LegalEntity getLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -211,31 +209,33 @@ public VerificationErrors checkLegalEntitysVerificationErrors(String id, Request pathParams.put("id", id); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/checkVerificationErrors", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return VerificationErrors.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return LegalEntity.fromJson(jsonResult); } /** - * Confirm data review + * Update a legal entity * * @param id {@link String } The unique identifier of the legal entity. (required) - * @return {@link DataReviewConfirmationResponse } + * @param legalEntityInfo {@link LegalEntityInfo } (required) + * @return {@link LegalEntity } * @throws ApiException if fails to make API call */ - public DataReviewConfirmationResponse confirmDataReview(String id) throws ApiException, IOException { - return confirmDataReview(id, null); + public LegalEntity updateLegalEntity(String id, LegalEntityInfo legalEntityInfo) throws ApiException, IOException { + return updateLegalEntity(id, legalEntityInfo, null); } /** - * Confirm data review + * Update a legal entity * * @param id {@link String } The unique identifier of the legal entity. (required) + * @param legalEntityInfo {@link LegalEntityInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link DataReviewConfirmationResponse } + * @return {@link LegalEntity } * @throws ApiException if fails to make API call */ - public DataReviewConfirmationResponse confirmDataReview(String id, RequestOptions requestOptions) throws ApiException, IOException { + public LegalEntity updateLegalEntity(String id, LegalEntityInfo legalEntityInfo, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -243,9 +243,9 @@ public DataReviewConfirmationResponse confirmDataReview(String id, RequestOption } pathParams.put("id", id); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/confirmDataReview", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return DataReviewConfirmationResponse.fromJson(jsonResult); + String requestBody = legalEntityInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return LegalEntity.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/legalentitymanagement/PciQuestionnairesApi.java b/src/main/java/com/adyen/service/legalentitymanagement/PciQuestionnairesApi.java index 2659047cc..2f02dd14e 100644 --- a/src/main/java/com/adyen/service/legalentitymanagement/PciQuestionnairesApi.java +++ b/src/main/java/com/adyen/service/legalentitymanagement/PciQuestionnairesApi.java @@ -56,25 +56,27 @@ public PciQuestionnairesApi(Client client, String baseURL) { } /** - * Get PCI questionnaire details + * Generate PCI questionnaire * * @param id {@link String } The unique identifier of the legal entity to get PCI questionnaire information. (required) - * @return {@link GetPciQuestionnaireInfosResponse } + * @param generatePciDescriptionRequest {@link GeneratePciDescriptionRequest } (required) + * @return {@link GeneratePciDescriptionResponse } * @throws ApiException if fails to make API call */ - public GetPciQuestionnaireInfosResponse getPciQuestionnaireDetails(String id) throws ApiException, IOException { - return getPciQuestionnaireDetails(id, null); + public GeneratePciDescriptionResponse generatePciQuestionnaire(String id, GeneratePciDescriptionRequest generatePciDescriptionRequest) throws ApiException, IOException { + return generatePciQuestionnaire(id, generatePciDescriptionRequest, null); } /** - * Get PCI questionnaire details + * Generate PCI questionnaire * * @param id {@link String } The unique identifier of the legal entity to get PCI questionnaire information. (required) + * @param generatePciDescriptionRequest {@link GeneratePciDescriptionRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GetPciQuestionnaireInfosResponse } + * @return {@link GeneratePciDescriptionResponse } * @throws ApiException if fails to make API call */ - public GetPciQuestionnaireInfosResponse getPciQuestionnaireDetails(String id, RequestOptions requestOptions) throws ApiException, IOException { + public GeneratePciDescriptionResponse generatePciQuestionnaire(String id, GeneratePciDescriptionRequest generatePciDescriptionRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -82,10 +84,10 @@ public GetPciQuestionnaireInfosResponse getPciQuestionnaireDetails(String id, Re } pathParams.put("id", id); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/pciQuestionnaires", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return GetPciQuestionnaireInfosResponse.fromJson(jsonResult); + String requestBody = generatePciDescriptionRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/pciQuestionnaires/generatePciTemplates", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return GeneratePciDescriptionResponse.fromJson(jsonResult); } /** @@ -128,27 +130,25 @@ public GetPciQuestionnaireResponse getPciQuestionnaire(String id, String pciid, } /** - * Generate PCI questionnaire + * Get PCI questionnaire details * * @param id {@link String } The unique identifier of the legal entity to get PCI questionnaire information. (required) - * @param generatePciDescriptionRequest {@link GeneratePciDescriptionRequest } (required) - * @return {@link GeneratePciDescriptionResponse } + * @return {@link GetPciQuestionnaireInfosResponse } * @throws ApiException if fails to make API call */ - public GeneratePciDescriptionResponse generatePciQuestionnaire(String id, GeneratePciDescriptionRequest generatePciDescriptionRequest) throws ApiException, IOException { - return generatePciQuestionnaire(id, generatePciDescriptionRequest, null); + public GetPciQuestionnaireInfosResponse getPciQuestionnaireDetails(String id) throws ApiException, IOException { + return getPciQuestionnaireDetails(id, null); } /** - * Generate PCI questionnaire + * Get PCI questionnaire details * * @param id {@link String } The unique identifier of the legal entity to get PCI questionnaire information. (required) - * @param generatePciDescriptionRequest {@link GeneratePciDescriptionRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GeneratePciDescriptionResponse } + * @return {@link GetPciQuestionnaireInfosResponse } * @throws ApiException if fails to make API call */ - public GeneratePciDescriptionResponse generatePciQuestionnaire(String id, GeneratePciDescriptionRequest generatePciDescriptionRequest, RequestOptions requestOptions) throws ApiException, IOException { + public GetPciQuestionnaireInfosResponse getPciQuestionnaireDetails(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -156,16 +156,16 @@ public GeneratePciDescriptionResponse generatePciQuestionnaire(String id, Genera } pathParams.put("id", id); - String requestBody = generatePciDescriptionRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/pciQuestionnaires/generatePciTemplates", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return GeneratePciDescriptionResponse.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/pciQuestionnaires", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return GetPciQuestionnaireInfosResponse.fromJson(jsonResult); } /** * Sign PCI questionnaire * - * @param id {@link String } The legal entity ID of the individual who signed the PCI questionnaire. (required) + * @param id {@link String } The legal entity ID of the user that has a contractual relationship with your platform. (required) * @param pciSigningRequest {@link PciSigningRequest } (required) * @return {@link PciSigningResponse } * @throws ApiException if fails to make API call @@ -177,7 +177,7 @@ public PciSigningResponse signPciQuestionnaire(String id, PciSigningRequest pciS /** * Sign PCI questionnaire * - * @param id {@link String } The legal entity ID of the individual who signed the PCI questionnaire. (required) + * @param id {@link String } The legal entity ID of the user that has a contractual relationship with your platform. (required) * @param pciSigningRequest {@link PciSigningRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link PciSigningResponse } diff --git a/src/main/java/com/adyen/service/legalentitymanagement/TermsOfServiceApi.java b/src/main/java/com/adyen/service/legalentitymanagement/TermsOfServiceApi.java index 3e7b7de63..a1d3a1188 100644 --- a/src/main/java/com/adyen/service/legalentitymanagement/TermsOfServiceApi.java +++ b/src/main/java/com/adyen/service/legalentitymanagement/TermsOfServiceApi.java @@ -56,58 +56,68 @@ public TermsOfServiceApi(Client client, String baseURL) { } /** - * Get Terms of Service information for a legal entity + * Accept Terms of Service * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) - * @return {@link GetTermsOfServiceAcceptanceInfosResponse } + * @param termsofservicedocumentid {@link String } The unique identifier of the Terms of Service document. (required) + * @param acceptTermsOfServiceRequest {@link AcceptTermsOfServiceRequest } (required) + * @return {@link AcceptTermsOfServiceResponse } * @throws ApiException if fails to make API call */ - public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id) throws ApiException, IOException { - return getTermsOfServiceInformationForLegalEntity(id, null); + public AcceptTermsOfServiceResponse acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest) throws ApiException, IOException { + return acceptTermsOfService(id, termsofservicedocumentid, acceptTermsOfServiceRequest, null); } /** - * Get Terms of Service information for a legal entity + * Accept Terms of Service * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) + * @param termsofservicedocumentid {@link String } The unique identifier of the Terms of Service document. (required) + * @param acceptTermsOfServiceRequest {@link AcceptTermsOfServiceRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GetTermsOfServiceAcceptanceInfosResponse } + * @return {@link AcceptTermsOfServiceResponse } * @throws ApiException if fails to make API call */ - public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException { + public AcceptTermsOfServiceResponse acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { throw new IllegalArgumentException("Please provide the id path parameter"); } pathParams.put("id", id); + if (termsofservicedocumentid == null) { + throw new IllegalArgumentException("Please provide the termsofservicedocumentid path parameter"); + } + pathParams.put("termsofservicedocumentid", termsofservicedocumentid); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfServiceAcceptanceInfos", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return GetTermsOfServiceAcceptanceInfosResponse.fromJson(jsonResult); + String requestBody = acceptTermsOfServiceRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfService/{termsofservicedocumentid}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return AcceptTermsOfServiceResponse.fromJson(jsonResult); } /** - * Get Terms of Service status + * Get Terms of Service document * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) - * @return {@link CalculateTermsOfServiceStatusResponse } + * @param getTermsOfServiceDocumentRequest {@link GetTermsOfServiceDocumentRequest } (required) + * @return {@link GetTermsOfServiceDocumentResponse } * @throws ApiException if fails to make API call */ - public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id) throws ApiException, IOException { - return getTermsOfServiceStatus(id, null); + public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest) throws ApiException, IOException { + return getTermsOfServiceDocument(id, getTermsOfServiceDocumentRequest, null); } /** - * Get Terms of Service status + * Get Terms of Service document * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) + * @param getTermsOfServiceDocumentRequest {@link GetTermsOfServiceDocumentRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CalculateTermsOfServiceStatusResponse } + * @return {@link GetTermsOfServiceDocumentResponse } * @throws ApiException if fails to make API call */ - public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id, RequestOptions requestOptions) throws ApiException, IOException { + public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -115,75 +125,65 @@ public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id, } pathParams.put("id", id); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfServiceStatus", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return CalculateTermsOfServiceStatusResponse.fromJson(jsonResult); + String requestBody = getTermsOfServiceDocumentRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfService", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return GetTermsOfServiceDocumentResponse.fromJson(jsonResult); } /** - * Accept Terms of Service + * Get Terms of Service information for a legal entity * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) - * @param termsofservicedocumentid {@link String } The unique identifier of the Terms of Service document. (required) - * @param acceptTermsOfServiceRequest {@link AcceptTermsOfServiceRequest } (required) - * @return {@link AcceptTermsOfServiceResponse } + * @return {@link GetTermsOfServiceAcceptanceInfosResponse } * @throws ApiException if fails to make API call */ - public AcceptTermsOfServiceResponse acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest) throws ApiException, IOException { - return acceptTermsOfService(id, termsofservicedocumentid, acceptTermsOfServiceRequest, null); + public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id) throws ApiException, IOException { + return getTermsOfServiceInformationForLegalEntity(id, null); } /** - * Accept Terms of Service + * Get Terms of Service information for a legal entity * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) - * @param termsofservicedocumentid {@link String } The unique identifier of the Terms of Service document. (required) - * @param acceptTermsOfServiceRequest {@link AcceptTermsOfServiceRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AcceptTermsOfServiceResponse } + * @return {@link GetTermsOfServiceAcceptanceInfosResponse } * @throws ApiException if fails to make API call */ - public AcceptTermsOfServiceResponse acceptTermsOfService(String id, String termsofservicedocumentid, AcceptTermsOfServiceRequest acceptTermsOfServiceRequest, RequestOptions requestOptions) throws ApiException, IOException { + public GetTermsOfServiceAcceptanceInfosResponse getTermsOfServiceInformationForLegalEntity(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { throw new IllegalArgumentException("Please provide the id path parameter"); } pathParams.put("id", id); - if (termsofservicedocumentid == null) { - throw new IllegalArgumentException("Please provide the termsofservicedocumentid path parameter"); - } - pathParams.put("termsofservicedocumentid", termsofservicedocumentid); - String requestBody = acceptTermsOfServiceRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfService/{termsofservicedocumentid}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return AcceptTermsOfServiceResponse.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfServiceAcceptanceInfos", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return GetTermsOfServiceAcceptanceInfosResponse.fromJson(jsonResult); } /** - * Get Terms of Service document + * Get Terms of Service status * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) - * @param getTermsOfServiceDocumentRequest {@link GetTermsOfServiceDocumentRequest } (required) - * @return {@link GetTermsOfServiceDocumentResponse } + * @return {@link CalculateTermsOfServiceStatusResponse } * @throws ApiException if fails to make API call */ - public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest) throws ApiException, IOException { - return getTermsOfServiceDocument(id, getTermsOfServiceDocumentRequest, null); + public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id) throws ApiException, IOException { + return getTermsOfServiceStatus(id, null); } /** - * Get Terms of Service document + * Get Terms of Service status * * @param id {@link String } The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. (required) - * @param getTermsOfServiceDocumentRequest {@link GetTermsOfServiceDocumentRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GetTermsOfServiceDocumentResponse } + * @return {@link CalculateTermsOfServiceStatusResponse } * @throws ApiException if fails to make API call */ - public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, GetTermsOfServiceDocumentRequest getTermsOfServiceDocumentRequest, RequestOptions requestOptions) throws ApiException, IOException { + public CalculateTermsOfServiceStatusResponse getTermsOfServiceStatus(String id, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (id == null) { @@ -191,9 +191,9 @@ public GetTermsOfServiceDocumentResponse getTermsOfServiceDocument(String id, Ge } pathParams.put("id", id); - String requestBody = getTermsOfServiceDocumentRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfService", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return GetTermsOfServiceDocumentResponse.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/legalEntities/{id}/termsOfServiceStatus", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return CalculateTermsOfServiceStatusResponse.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/legalentitymanagement/TransferInstrumentsApi.java b/src/main/java/com/adyen/service/legalentitymanagement/TransferInstrumentsApi.java index f5fa61221..d69589641 100644 --- a/src/main/java/com/adyen/service/legalentitymanagement/TransferInstrumentsApi.java +++ b/src/main/java/com/adyen/service/legalentitymanagement/TransferInstrumentsApi.java @@ -51,6 +51,33 @@ public TransferInstrumentsApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Create a transfer instrument + * + * @param transferInstrumentInfo {@link TransferInstrumentInfo } (required) + * @return {@link TransferInstrument } + * @throws ApiException if fails to make API call + */ + public TransferInstrument createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo) throws ApiException, IOException { + return createTransferInstrument(transferInstrumentInfo, null); + } + + /** + * Create a transfer instrument + * + * @param transferInstrumentInfo {@link TransferInstrumentInfo } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link TransferInstrument } + * @throws ApiException if fails to make API call + */ + public TransferInstrument createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = transferInstrumentInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/transferInstruments", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return TransferInstrument.fromJson(jsonResult); + } + /** * Delete a transfer instrument * @@ -148,31 +175,4 @@ public TransferInstrument updateTransferInstrument(String id, TransferInstrument String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return TransferInstrument.fromJson(jsonResult); } - - /** - * Create a transfer instrument - * - * @param transferInstrumentInfo {@link TransferInstrumentInfo } (required) - * @return {@link TransferInstrument } - * @throws ApiException if fails to make API call - */ - public TransferInstrument createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo) throws ApiException, IOException { - return createTransferInstrument(transferInstrumentInfo, null); - } - - /** - * Create a transfer instrument - * - * @param transferInstrumentInfo {@link TransferInstrumentInfo } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TransferInstrument } - * @throws ApiException if fails to make API call - */ - public TransferInstrument createTransferInstrument(TransferInstrumentInfo transferInstrumentInfo, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = transferInstrumentInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/transferInstruments", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return TransferInstrument.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/management/AccountCompanyLevelApi.java b/src/main/java/com/adyen/service/management/AccountCompanyLevelApi.java index 2ca85e660..8e593199c 100644 --- a/src/main/java/com/adyen/service/management/AccountCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/AccountCompanyLevelApi.java @@ -52,6 +52,39 @@ public AccountCompanyLevelApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Get a company account + * + * @param companyId {@link String } The unique identifier of the company account. (required) + * @return {@link Company } + * @throws ApiException if fails to make API call + */ + public Company getCompanyAccount(String companyId) throws ApiException, IOException { + return getCompanyAccount(companyId, null); + } + + /** + * Get a company account + * + * @param companyId {@link String } The unique identifier of the company account. (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link Company } + * @throws ApiException if fails to make API call + */ + public Company getCompanyAccount(String companyId, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (companyId == null) { + throw new IllegalArgumentException("Please provide the companyId path parameter"); + } + pathParams.put("companyId", companyId); + + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return Company.fromJson(jsonResult); + } + /** * Get a list of company accounts * @@ -87,39 +120,6 @@ public ListCompanyResponse listCompanyAccounts(Integer pageNumber, Integer pageS return ListCompanyResponse.fromJson(jsonResult); } - /** - * Get a company account - * - * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link Company } - * @throws ApiException if fails to make API call - */ - public Company getCompanyAccount(String companyId) throws ApiException, IOException { - return getCompanyAccount(companyId, null); - } - - /** - * Get a company account - * - * @param companyId {@link String } The unique identifier of the company account. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Company } - * @throws ApiException if fails to make API call - */ - public Company getCompanyAccount(String companyId, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (companyId == null) { - throw new IllegalArgumentException("Please provide the companyId path parameter"); - } - pathParams.put("companyId", companyId); - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return Company.fromJson(jsonResult); - } - /** * Get a list of merchant accounts * diff --git a/src/main/java/com/adyen/service/management/AccountMerchantLevelApi.java b/src/main/java/com/adyen/service/management/AccountMerchantLevelApi.java index 88596004c..0ac816728 100644 --- a/src/main/java/com/adyen/service/management/AccountMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/AccountMerchantLevelApi.java @@ -55,38 +55,30 @@ public AccountMerchantLevelApi(Client client, String baseURL) { } /** - * Get a list of merchant accounts + * Create a merchant account * - * @return {@link ListMerchantResponse } + * @param createMerchantRequest {@link CreateMerchantRequest } (required) + * @return {@link CreateMerchantResponse } * @throws ApiException if fails to make API call */ - public ListMerchantResponse listMerchantAccounts() throws ApiException, IOException { - return listMerchantAccounts(null, null, null); + public CreateMerchantResponse createMerchantAccount(CreateMerchantRequest createMerchantRequest) throws ApiException, IOException { + return createMerchantAccount(createMerchantRequest, null); } /** - * Get a list of merchant accounts + * Create a merchant account * - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) + * @param createMerchantRequest {@link CreateMerchantRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListMerchantResponse } + * @return {@link CreateMerchantResponse } * @throws ApiException if fails to make API call */ - public ListMerchantResponse listMerchantAccounts(Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); - } + public CreateMerchantResponse createMerchantAccount(CreateMerchantRequest createMerchantRequest, RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = null; + String requestBody = createMerchantRequest.toJson(); Resource resource = new Resource(this, this.baseURL + "/merchants", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null, queryParams); - return ListMerchantResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return CreateMerchantResponse.fromJson(jsonResult); } /** @@ -123,30 +115,38 @@ public Merchant getMerchantAccount(String merchantId, RequestOptions requestOpti } /** - * Create a merchant account + * Get a list of merchant accounts * - * @param createMerchantRequest {@link CreateMerchantRequest } (required) - * @return {@link CreateMerchantResponse } + * @return {@link ListMerchantResponse } * @throws ApiException if fails to make API call */ - public CreateMerchantResponse createMerchantAccount(CreateMerchantRequest createMerchantRequest) throws ApiException, IOException { - return createMerchantAccount(createMerchantRequest, null); + public ListMerchantResponse listMerchantAccounts() throws ApiException, IOException { + return listMerchantAccounts(null, null, null); } /** - * Create a merchant account + * Get a list of merchant accounts * - * @param createMerchantRequest {@link CreateMerchantRequest } (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CreateMerchantResponse } + * @return {@link ListMerchantResponse } * @throws ApiException if fails to make API call */ - public CreateMerchantResponse createMerchantAccount(CreateMerchantRequest createMerchantRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ListMerchantResponse listMerchantAccounts(Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); + } - String requestBody = createMerchantRequest.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/merchants", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return CreateMerchantResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null, queryParams); + return ListMerchantResponse.fromJson(jsonResult); } /** diff --git a/src/main/java/com/adyen/service/management/AccountStoreLevelApi.java b/src/main/java/com/adyen/service/management/AccountStoreLevelApi.java index 3c3eee812..5a537b8ee 100644 --- a/src/main/java/com/adyen/service/management/AccountStoreLevelApi.java +++ b/src/main/java/com/adyen/service/management/AccountStoreLevelApi.java @@ -55,50 +55,65 @@ public AccountStoreLevelApi(Client client, String baseURL) { } /** - * Get a list of stores + * Create a store + * + * @param storeCreationWithMerchantCodeRequest {@link StoreCreationWithMerchantCodeRequest } (required) + * @return {@link Store } + * @throws ApiException if fails to make API call + */ + public Store createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest) throws ApiException, IOException { + return createStore(storeCreationWithMerchantCodeRequest, null); + } + + /** + * Create a store + * + * @param storeCreationWithMerchantCodeRequest {@link StoreCreationWithMerchantCodeRequest } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link Store } + * @throws ApiException if fails to make API call + */ + public Store createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest, RequestOptions requestOptions) throws ApiException, IOException { + + String requestBody = storeCreationWithMerchantCodeRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/stores", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return Store.fromJson(jsonResult); + } + + /** + * Create a store * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link ListStoresResponse } + * @param storeCreationRequest {@link StoreCreationRequest } (required) + * @return {@link Store } * @throws ApiException if fails to make API call */ - public ListStoresResponse listStoresByMerchantId(String merchantId) throws ApiException, IOException { - return listStoresByMerchantId(merchantId, null, null, null, null); + public Store createStoreByMerchantId(String merchantId, StoreCreationRequest storeCreationRequest) throws ApiException, IOException { + return createStoreByMerchantId(merchantId, storeCreationRequest, null); } /** - * Get a list of stores + * Create a store * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) - * @param reference {@link String } Query: The reference of the store. (optional) + * @param storeCreationRequest {@link StoreCreationRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListStoresResponse } + * @return {@link Store } * @throws ApiException if fails to make API call */ - public ListStoresResponse listStoresByMerchantId(String merchantId, Integer pageNumber, Integer pageSize, String reference, RequestOptions requestOptions) throws ApiException, IOException { + public Store createStoreByMerchantId(String merchantId, StoreCreationRequest storeCreationRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); - } - if (reference != null) { - queryParams.put("reference", reference); - } - String requestBody = null; + String requestBody = storeCreationRequest.toJson(); Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListStoresResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return Store.fromJson(jsonResult); } /** @@ -140,6 +155,39 @@ public Store getStore(String merchantId, String storeId, RequestOptions requestO return Store.fromJson(jsonResult); } + /** + * Get a store + * + * @param storeId {@link String } The unique identifier of the store. (required) + * @return {@link Store } + * @throws ApiException if fails to make API call + */ + public Store getStoreById(String storeId) throws ApiException, IOException { + return getStoreById(storeId, null); + } + + /** + * Get a store + * + * @param storeId {@link String } The unique identifier of the store. (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link Store } + * @throws ApiException if fails to make API call + */ + public Store getStoreById(String storeId, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (storeId == null) { + throw new IllegalArgumentException("Please provide the storeId path parameter"); + } + pathParams.put("storeId", storeId); + + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/stores/{storeId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return Store.fromJson(jsonResult); + } + /** * Get a list of stores * @@ -184,36 +232,50 @@ public ListStoresResponse listStores(Integer pageNumber, Integer pageSize, Strin } /** - * Get a store + * Get a list of stores * - * @param storeId {@link String } The unique identifier of the store. (required) - * @return {@link Store } + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @return {@link ListStoresResponse } * @throws ApiException if fails to make API call */ - public Store getStoreById(String storeId) throws ApiException, IOException { - return getStoreById(storeId, null); + public ListStoresResponse listStoresByMerchantId(String merchantId) throws ApiException, IOException { + return listStoresByMerchantId(merchantId, null, null, null, null); } /** - * Get a store + * Get a list of stores * - * @param storeId {@link String } The unique identifier of the store. (required) + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) + * @param reference {@link String } Query: The reference of the store. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Store } + * @return {@link ListStoresResponse } * @throws ApiException if fails to make API call */ - public Store getStoreById(String storeId, RequestOptions requestOptions) throws ApiException, IOException { + public ListStoresResponse listStoresByMerchantId(String merchantId, Integer pageNumber, Integer pageSize, String reference, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); - if (storeId == null) { - throw new IllegalArgumentException("Please provide the storeId path parameter"); + if (merchantId == null) { + throw new IllegalArgumentException("Please provide the merchantId path parameter"); + } + pathParams.put("merchantId", merchantId); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); + } + if (reference != null) { + queryParams.put("reference", reference); } - pathParams.put("storeId", storeId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/stores/{storeId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return Store.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListStoresResponse.fromJson(jsonResult); } /** @@ -291,66 +353,4 @@ public Store updateStoreById(String storeId, UpdateStoreRequest updateStoreReque String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return Store.fromJson(jsonResult); } - - /** - * Create a store - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param storeCreationRequest {@link StoreCreationRequest } (required) - * @return {@link Store } - * @throws ApiException if fails to make API call - */ - public Store createStoreByMerchantId(String merchantId, StoreCreationRequest storeCreationRequest) throws ApiException, IOException { - return createStoreByMerchantId(merchantId, storeCreationRequest, null); - } - - /** - * Create a store - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param storeCreationRequest {@link StoreCreationRequest } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Store } - * @throws ApiException if fails to make API call - */ - public Store createStoreByMerchantId(String merchantId, StoreCreationRequest storeCreationRequest, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (merchantId == null) { - throw new IllegalArgumentException("Please provide the merchantId path parameter"); - } - pathParams.put("merchantId", merchantId); - - String requestBody = storeCreationRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return Store.fromJson(jsonResult); - } - - /** - * Create a store - * - * @param storeCreationWithMerchantCodeRequest {@link StoreCreationWithMerchantCodeRequest } (required) - * @return {@link Store } - * @throws ApiException if fails to make API call - */ - public Store createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest) throws ApiException, IOException { - return createStore(storeCreationWithMerchantCodeRequest, null); - } - - /** - * Create a store - * - * @param storeCreationWithMerchantCodeRequest {@link StoreCreationWithMerchantCodeRequest } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Store } - * @throws ApiException if fails to make API call - */ - public Store createStore(StoreCreationWithMerchantCodeRequest storeCreationWithMerchantCodeRequest, RequestOptions requestOptions) throws ApiException, IOException { - - String requestBody = storeCreationWithMerchantCodeRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/stores", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return Store.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/management/AllowedOriginsCompanyLevelApi.java b/src/main/java/com/adyen/service/management/AllowedOriginsCompanyLevelApi.java index cc24658e8..6271002d1 100644 --- a/src/main/java/com/adyen/service/management/AllowedOriginsCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/AllowedOriginsCompanyLevelApi.java @@ -52,27 +52,29 @@ public AllowedOriginsCompanyLevelApi(Client client, String baseURL) { } /** - * Delete an allowed origin + * Create an allowed origin * * @param companyId {@link String } The unique identifier of the company account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param originId {@link String } Unique identifier of the allowed origin. (required) + * @param allowedOrigin {@link AllowedOrigin } (required) + * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public void deleteAllowedOrigin(String companyId, String apiCredentialId, String originId) throws ApiException, IOException { - deleteAllowedOrigin(companyId, apiCredentialId, originId, null); + public AllowedOriginsResponse createAllowedOrigin(String companyId, String apiCredentialId, AllowedOrigin allowedOrigin) throws ApiException, IOException { + return createAllowedOrigin(companyId, apiCredentialId, allowedOrigin, null); } /** - * Delete an allowed origin + * Create an allowed origin * * @param companyId {@link String } The unique identifier of the company account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param originId {@link String } Unique identifier of the allowed origin. (required) + * @param allowedOrigin {@link AllowedOrigin } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public void deleteAllowedOrigin(String companyId, String apiCredentialId, String originId, RequestOptions requestOptions) throws ApiException, IOException { + public AllowedOriginsResponse createAllowedOrigin(String companyId, String apiCredentialId, AllowedOrigin allowedOrigin, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -83,38 +85,35 @@ public void deleteAllowedOrigin(String companyId, String apiCredentialId, String throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); } pathParams.put("apiCredentialId", apiCredentialId); - if (originId == null) { - throw new IllegalArgumentException("Please provide the originId path parameter"); - } - pathParams.put("originId", originId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + String requestBody = allowedOrigin.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return AllowedOriginsResponse.fromJson(jsonResult); } /** - * Get a list of allowed origins + * Delete an allowed origin * * @param companyId {@link String } The unique identifier of the company account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @return {@link AllowedOriginsResponse } + * @param originId {@link String } Unique identifier of the allowed origin. (required) * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse listAllowedOrigins(String companyId, String apiCredentialId) throws ApiException, IOException { - return listAllowedOrigins(companyId, apiCredentialId, null); + public void deleteAllowedOrigin(String companyId, String apiCredentialId, String originId) throws ApiException, IOException { + deleteAllowedOrigin(companyId, apiCredentialId, originId, null); } /** - * Get a list of allowed origins + * Delete an allowed origin * * @param companyId {@link String } The unique identifier of the company account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) + * @param originId {@link String } Unique identifier of the allowed origin. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse listAllowedOrigins(String companyId, String apiCredentialId, RequestOptions requestOptions) throws ApiException, IOException { + public void deleteAllowedOrigin(String companyId, String apiCredentialId, String originId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -125,11 +124,14 @@ public AllowedOriginsResponse listAllowedOrigins(String companyId, String apiCre throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); } pathParams.put("apiCredentialId", apiCredentialId); + if (originId == null) { + throw new IllegalArgumentException("Please provide the originId path parameter"); + } + pathParams.put("originId", originId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return AllowedOriginsResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}", null); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); } /** @@ -178,29 +180,27 @@ public AllowedOrigin getAllowedOrigin(String companyId, String apiCredentialId, } /** - * Create an allowed origin + * Get a list of allowed origins * * @param companyId {@link String } The unique identifier of the company account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param allowedOrigin {@link AllowedOrigin } (required) * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse createAllowedOrigin(String companyId, String apiCredentialId, AllowedOrigin allowedOrigin) throws ApiException, IOException { - return createAllowedOrigin(companyId, apiCredentialId, allowedOrigin, null); + public AllowedOriginsResponse listAllowedOrigins(String companyId, String apiCredentialId) throws ApiException, IOException { + return listAllowedOrigins(companyId, apiCredentialId, null); } /** - * Create an allowed origin + * Get a list of allowed origins * * @param companyId {@link String } The unique identifier of the company account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param allowedOrigin {@link AllowedOrigin } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse createAllowedOrigin(String companyId, String apiCredentialId, AllowedOrigin allowedOrigin, RequestOptions requestOptions) throws ApiException, IOException { + public AllowedOriginsResponse listAllowedOrigins(String companyId, String apiCredentialId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -212,9 +212,9 @@ public AllowedOriginsResponse createAllowedOrigin(String companyId, String apiCr } pathParams.put("apiCredentialId", apiCredentialId); - String requestBody = allowedOrigin.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}/allowedOrigins", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); return AllowedOriginsResponse.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/AllowedOriginsMerchantLevelApi.java b/src/main/java/com/adyen/service/management/AllowedOriginsMerchantLevelApi.java index cc7471f91..9c71a69ec 100644 --- a/src/main/java/com/adyen/service/management/AllowedOriginsMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/AllowedOriginsMerchantLevelApi.java @@ -52,27 +52,29 @@ public AllowedOriginsMerchantLevelApi(Client client, String baseURL) { } /** - * Delete an allowed origin + * Create an allowed origin * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param originId {@link String } Unique identifier of the allowed origin. (required) + * @param allowedOrigin {@link AllowedOrigin } (required) + * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public void deleteAllowedOrigin(String merchantId, String apiCredentialId, String originId) throws ApiException, IOException { - deleteAllowedOrigin(merchantId, apiCredentialId, originId, null); + public AllowedOriginsResponse createAllowedOrigin(String merchantId, String apiCredentialId, AllowedOrigin allowedOrigin) throws ApiException, IOException { + return createAllowedOrigin(merchantId, apiCredentialId, allowedOrigin, null); } /** - * Delete an allowed origin + * Create an allowed origin * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param originId {@link String } Unique identifier of the allowed origin. (required) + * @param allowedOrigin {@link AllowedOrigin } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public void deleteAllowedOrigin(String merchantId, String apiCredentialId, String originId, RequestOptions requestOptions) throws ApiException, IOException { + public AllowedOriginsResponse createAllowedOrigin(String merchantId, String apiCredentialId, AllowedOrigin allowedOrigin, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -83,38 +85,35 @@ public void deleteAllowedOrigin(String merchantId, String apiCredentialId, Strin throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); } pathParams.put("apiCredentialId", apiCredentialId); - if (originId == null) { - throw new IllegalArgumentException("Please provide the originId path parameter"); - } - pathParams.put("originId", originId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + String requestBody = allowedOrigin.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return AllowedOriginsResponse.fromJson(jsonResult); } /** - * Get a list of allowed origins + * Delete an allowed origin * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @return {@link AllowedOriginsResponse } + * @param originId {@link String } Unique identifier of the allowed origin. (required) * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse listAllowedOrigins(String merchantId, String apiCredentialId) throws ApiException, IOException { - return listAllowedOrigins(merchantId, apiCredentialId, null); + public void deleteAllowedOrigin(String merchantId, String apiCredentialId, String originId) throws ApiException, IOException { + deleteAllowedOrigin(merchantId, apiCredentialId, originId, null); } /** - * Get a list of allowed origins + * Delete an allowed origin * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) + * @param originId {@link String } Unique identifier of the allowed origin. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse listAllowedOrigins(String merchantId, String apiCredentialId, RequestOptions requestOptions) throws ApiException, IOException { + public void deleteAllowedOrigin(String merchantId, String apiCredentialId, String originId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -125,11 +124,14 @@ public AllowedOriginsResponse listAllowedOrigins(String merchantId, String apiCr throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); } pathParams.put("apiCredentialId", apiCredentialId); + if (originId == null) { + throw new IllegalArgumentException("Please provide the originId path parameter"); + } + pathParams.put("originId", originId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return AllowedOriginsResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins/{originId}", null); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); } /** @@ -178,29 +180,27 @@ public AllowedOrigin getAllowedOrigin(String merchantId, String apiCredentialId, } /** - * Create an allowed origin + * Get a list of allowed origins * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param allowedOrigin {@link AllowedOrigin } (required) * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse createAllowedOrigin(String merchantId, String apiCredentialId, AllowedOrigin allowedOrigin) throws ApiException, IOException { - return createAllowedOrigin(merchantId, apiCredentialId, allowedOrigin, null); + public AllowedOriginsResponse listAllowedOrigins(String merchantId, String apiCredentialId) throws ApiException, IOException { + return listAllowedOrigins(merchantId, apiCredentialId, null); } /** - * Create an allowed origin + * Get a list of allowed origins * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param allowedOrigin {@link AllowedOrigin } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse createAllowedOrigin(String merchantId, String apiCredentialId, AllowedOrigin allowedOrigin, RequestOptions requestOptions) throws ApiException, IOException { + public AllowedOriginsResponse listAllowedOrigins(String merchantId, String apiCredentialId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -212,9 +212,9 @@ public AllowedOriginsResponse createAllowedOrigin(String merchantId, String apiC } pathParams.put("apiCredentialId", apiCredentialId); - String requestBody = allowedOrigin.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}/allowedOrigins", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); return AllowedOriginsResponse.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/AndroidFilesCompanyLevelApi.java b/src/main/java/com/adyen/service/management/AndroidFilesCompanyLevelApi.java index 46c7ab7b7..fde139a20 100644 --- a/src/main/java/com/adyen/service/management/AndroidFilesCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/AndroidFilesCompanyLevelApi.java @@ -18,6 +18,7 @@ import com.adyen.model.management.AndroidAppsResponse; import com.adyen.model.management.AndroidCertificatesResponse; import com.adyen.model.management.RestServiceError; +import com.adyen.model.management.UploadAndroidAppResponse; import com.adyen.model.RequestOptions; import com.adyen.service.exception.ApiException; import com.adyen.service.resource.Resource; @@ -52,6 +53,45 @@ public AndroidFilesCompanyLevelApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Get Android app + * + * @param companyId {@link String } The unique identifier of the company account. (required) + * @param id {@link String } The unique identifier of the app. (required) + * @return {@link AndroidApp } + * @throws ApiException if fails to make API call + */ + public AndroidApp getAndroidApp(String companyId, String id) throws ApiException, IOException { + return getAndroidApp(companyId, id, null); + } + + /** + * Get Android app + * + * @param companyId {@link String } The unique identifier of the company account. (required) + * @param id {@link String } The unique identifier of the app. (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link AndroidApp } + * @throws ApiException if fails to make API call + */ + public AndroidApp getAndroidApp(String companyId, String id, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (companyId == null) { + throw new IllegalArgumentException("Please provide the companyId path parameter"); + } + pathParams.put("companyId", companyId); + if (id == null) { + throw new IllegalArgumentException("Please provide the id path parameter"); + } + pathParams.put("id", id); + + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/androidApps/{id}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return AndroidApp.fromJson(jsonResult); + } + /** * Get a list of Android apps * @@ -103,45 +143,6 @@ public AndroidAppsResponse listAndroidApps(String companyId, Integer pageNumber, return AndroidAppsResponse.fromJson(jsonResult); } - /** - * Get Android app - * - * @param companyId {@link String } The unique identifier of the company account. (required) - * @param id {@link String } The unique identifier of the app. (required) - * @return {@link AndroidApp } - * @throws ApiException if fails to make API call - */ - public AndroidApp getAndroidApp(String companyId, String id) throws ApiException, IOException { - return getAndroidApp(companyId, id, null); - } - - /** - * Get Android app - * - * @param companyId {@link String } The unique identifier of the company account. (required) - * @param id {@link String } The unique identifier of the app. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AndroidApp } - * @throws ApiException if fails to make API call - */ - public AndroidApp getAndroidApp(String companyId, String id, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (companyId == null) { - throw new IllegalArgumentException("Please provide the companyId path parameter"); - } - pathParams.put("companyId", companyId); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/androidApps/{id}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return AndroidApp.fromJson(jsonResult); - } - /** * Get a list of Android certificates * @@ -193,10 +194,11 @@ public AndroidCertificatesResponse listAndroidCertificates(String companyId, Int * Upload Android App * * @param companyId {@link String } The unique identifier of the company account. (required) + * @return {@link UploadAndroidAppResponse } * @throws ApiException if fails to make API call */ - public void uploadAndroidApp(String companyId) throws ApiException, IOException { - uploadAndroidApp(companyId, null); + public UploadAndroidAppResponse uploadAndroidApp(String companyId) throws ApiException, IOException { + return uploadAndroidApp(companyId, null); } /** @@ -204,9 +206,10 @@ public void uploadAndroidApp(String companyId) throws ApiException, IOException * * @param companyId {@link String } The unique identifier of the company account. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link UploadAndroidAppResponse } * @throws ApiException if fails to make API call */ - public void uploadAndroidApp(String companyId, RequestOptions requestOptions) throws ApiException, IOException { + public UploadAndroidAppResponse uploadAndroidApp(String companyId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -216,6 +219,7 @@ public void uploadAndroidApp(String companyId, RequestOptions requestOptions) th String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/androidApps", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return UploadAndroidAppResponse.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/ApiCredentialsCompanyLevelApi.java b/src/main/java/com/adyen/service/management/ApiCredentialsCompanyLevelApi.java index bb1886376..a45a5acb3 100644 --- a/src/main/java/com/adyen/service/management/ApiCredentialsCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/ApiCredentialsCompanyLevelApi.java @@ -55,46 +55,38 @@ public ApiCredentialsCompanyLevelApi(Client client, String baseURL) { } /** - * Get a list of API credentials + * Create an API credential. * * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link ListCompanyApiCredentialsResponse } + * @param createCompanyApiCredentialRequest {@link CreateCompanyApiCredentialRequest } (required) + * @return {@link CreateCompanyApiCredentialResponse } * @throws ApiException if fails to make API call */ - public ListCompanyApiCredentialsResponse listApiCredentials(String companyId) throws ApiException, IOException { - return listApiCredentials(companyId, null, null, null); + public CreateCompanyApiCredentialResponse createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest) throws ApiException, IOException { + return createApiCredential(companyId, createCompanyApiCredentialRequest, null); } /** - * Get a list of API credentials + * Create an API credential. * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) + * @param createCompanyApiCredentialRequest {@link CreateCompanyApiCredentialRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListCompanyApiCredentialsResponse } + * @return {@link CreateCompanyApiCredentialResponse } * @throws ApiException if fails to make API call */ - public ListCompanyApiCredentialsResponse listApiCredentials(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { + public CreateCompanyApiCredentialResponse createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); - } - String requestBody = null; + String requestBody = createCompanyApiCredentialRequest.toJson(); Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListCompanyApiCredentialsResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return CreateCompanyApiCredentialResponse.fromJson(jsonResult); } /** @@ -137,78 +129,86 @@ public CompanyApiCredential getApiCredential(String companyId, String apiCredent } /** - * Update an API credential. + * Get a list of API credentials * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param updateCompanyApiCredentialRequest {@link UpdateCompanyApiCredentialRequest } (required) - * @return {@link CompanyApiCredential } + * @return {@link ListCompanyApiCredentialsResponse } * @throws ApiException if fails to make API call */ - public CompanyApiCredential updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest) throws ApiException, IOException { - return updateApiCredential(companyId, apiCredentialId, updateCompanyApiCredentialRequest, null); + public ListCompanyApiCredentialsResponse listApiCredentials(String companyId) throws ApiException, IOException { + return listApiCredentials(companyId, null, null, null); } /** - * Update an API credential. + * Get a list of API credentials * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param updateCompanyApiCredentialRequest {@link UpdateCompanyApiCredentialRequest } (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CompanyApiCredential } + * @return {@link ListCompanyApiCredentialsResponse } * @throws ApiException if fails to make API call */ - public CompanyApiCredential updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ListCompanyApiCredentialsResponse listApiCredentials(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - if (apiCredentialId == null) { - throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); } - pathParams.put("apiCredentialId", apiCredentialId); - String requestBody = updateCompanyApiCredentialRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return CompanyApiCredential.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListCompanyApiCredentialsResponse.fromJson(jsonResult); } /** - * Create an API credential. + * Update an API credential. * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param createCompanyApiCredentialRequest {@link CreateCompanyApiCredentialRequest } (required) - * @return {@link CreateCompanyApiCredentialResponse } + * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) + * @param updateCompanyApiCredentialRequest {@link UpdateCompanyApiCredentialRequest } (required) + * @return {@link CompanyApiCredential } * @throws ApiException if fails to make API call */ - public CreateCompanyApiCredentialResponse createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest) throws ApiException, IOException { - return createApiCredential(companyId, createCompanyApiCredentialRequest, null); + public CompanyApiCredential updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest) throws ApiException, IOException { + return updateApiCredential(companyId, apiCredentialId, updateCompanyApiCredentialRequest, null); } /** - * Create an API credential. + * Update an API credential. * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param createCompanyApiCredentialRequest {@link CreateCompanyApiCredentialRequest } (required) + * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) + * @param updateCompanyApiCredentialRequest {@link UpdateCompanyApiCredentialRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CreateCompanyApiCredentialResponse } + * @return {@link CompanyApiCredential } * @throws ApiException if fails to make API call */ - public CreateCompanyApiCredentialResponse createApiCredential(String companyId, CreateCompanyApiCredentialRequest createCompanyApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { + public CompanyApiCredential updateApiCredential(String companyId, String apiCredentialId, UpdateCompanyApiCredentialRequest updateCompanyApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); + if (apiCredentialId == null) { + throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); + } + pathParams.put("apiCredentialId", apiCredentialId); - String requestBody = createCompanyApiCredentialRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return CreateCompanyApiCredentialResponse.fromJson(jsonResult); + String requestBody = updateCompanyApiCredentialRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/apiCredentials/{apiCredentialId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return CompanyApiCredential.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/ApiCredentialsMerchantLevelApi.java b/src/main/java/com/adyen/service/management/ApiCredentialsMerchantLevelApi.java index d8ab39a36..d46c5e703 100644 --- a/src/main/java/com/adyen/service/management/ApiCredentialsMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/ApiCredentialsMerchantLevelApi.java @@ -55,46 +55,38 @@ public ApiCredentialsMerchantLevelApi(Client client, String baseURL) { } /** - * Get a list of API credentials + * Create an API credential * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link ListMerchantApiCredentialsResponse } + * @param createMerchantApiCredentialRequest {@link CreateMerchantApiCredentialRequest } (required) + * @return {@link CreateApiCredentialResponse } * @throws ApiException if fails to make API call */ - public ListMerchantApiCredentialsResponse listApiCredentials(String merchantId) throws ApiException, IOException { - return listApiCredentials(merchantId, null, null, null); + public CreateApiCredentialResponse createApiCredential(String merchantId, CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest) throws ApiException, IOException { + return createApiCredential(merchantId, createMerchantApiCredentialRequest, null); } /** - * Get a list of API credentials + * Create an API credential * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) + * @param createMerchantApiCredentialRequest {@link CreateMerchantApiCredentialRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListMerchantApiCredentialsResponse } + * @return {@link CreateApiCredentialResponse } * @throws ApiException if fails to make API call */ - public ListMerchantApiCredentialsResponse listApiCredentials(String merchantId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { + public CreateApiCredentialResponse createApiCredential(String merchantId, CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); - } - String requestBody = null; + String requestBody = createMerchantApiCredentialRequest.toJson(); Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListMerchantApiCredentialsResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return CreateApiCredentialResponse.fromJson(jsonResult); } /** @@ -137,78 +129,86 @@ public ApiCredential getApiCredential(String merchantId, String apiCredentialId, } /** - * Update an API credential + * Get a list of API credentials * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param updateMerchantApiCredentialRequest {@link UpdateMerchantApiCredentialRequest } (required) - * @return {@link ApiCredential } + * @return {@link ListMerchantApiCredentialsResponse } * @throws ApiException if fails to make API call */ - public ApiCredential updateApiCredential(String merchantId, String apiCredentialId, UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest) throws ApiException, IOException { - return updateApiCredential(merchantId, apiCredentialId, updateMerchantApiCredentialRequest, null); + public ListMerchantApiCredentialsResponse listApiCredentials(String merchantId) throws ApiException, IOException { + return listApiCredentials(merchantId, null, null, null); } /** - * Update an API credential + * Get a list of API credentials * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) - * @param updateMerchantApiCredentialRequest {@link UpdateMerchantApiCredentialRequest } (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ApiCredential } + * @return {@link ListMerchantApiCredentialsResponse } * @throws ApiException if fails to make API call */ - public ApiCredential updateApiCredential(String merchantId, String apiCredentialId, UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ListMerchantApiCredentialsResponse listApiCredentials(String merchantId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (apiCredentialId == null) { - throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); } - pathParams.put("apiCredentialId", apiCredentialId); - String requestBody = updateMerchantApiCredentialRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return ApiCredential.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListMerchantApiCredentialsResponse.fromJson(jsonResult); } /** - * Create an API credential + * Update an API credential * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param createMerchantApiCredentialRequest {@link CreateMerchantApiCredentialRequest } (required) - * @return {@link CreateApiCredentialResponse } + * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) + * @param updateMerchantApiCredentialRequest {@link UpdateMerchantApiCredentialRequest } (required) + * @return {@link ApiCredential } * @throws ApiException if fails to make API call */ - public CreateApiCredentialResponse createApiCredential(String merchantId, CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest) throws ApiException, IOException { - return createApiCredential(merchantId, createMerchantApiCredentialRequest, null); + public ApiCredential updateApiCredential(String merchantId, String apiCredentialId, UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest) throws ApiException, IOException { + return updateApiCredential(merchantId, apiCredentialId, updateMerchantApiCredentialRequest, null); } /** - * Create an API credential + * Update an API credential * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param createMerchantApiCredentialRequest {@link CreateMerchantApiCredentialRequest } (required) + * @param apiCredentialId {@link String } Unique identifier of the API credential. (required) + * @param updateMerchantApiCredentialRequest {@link UpdateMerchantApiCredentialRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CreateApiCredentialResponse } + * @return {@link ApiCredential } * @throws ApiException if fails to make API call */ - public CreateApiCredentialResponse createApiCredential(String merchantId, CreateMerchantApiCredentialRequest createMerchantApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ApiCredential updateApiCredential(String merchantId, String apiCredentialId, UpdateMerchantApiCredentialRequest updateMerchantApiCredentialRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); + if (apiCredentialId == null) { + throw new IllegalArgumentException("Please provide the apiCredentialId path parameter"); + } + pathParams.put("apiCredentialId", apiCredentialId); - String requestBody = createMerchantApiCredentialRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return CreateApiCredentialResponse.fromJson(jsonResult); + String requestBody = updateMerchantApiCredentialRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/apiCredentials/{apiCredentialId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return ApiCredential.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/MyApiCredentialApi.java b/src/main/java/com/adyen/service/management/MyApiCredentialApi.java index 35e0d8364..6ae7a526f 100644 --- a/src/main/java/com/adyen/service/management/MyApiCredentialApi.java +++ b/src/main/java/com/adyen/service/management/MyApiCredentialApi.java @@ -55,83 +55,55 @@ public MyApiCredentialApi(Client client, String baseURL) { } /** - * Remove allowed origin - * - * @param originId {@link String } Unique identifier of the allowed origin. (required) - * @throws ApiException if fails to make API call - */ - public void removeAllowedOrigin(String originId) throws ApiException, IOException { - removeAllowedOrigin(originId, null); - } - - /** - * Remove allowed origin - * - * @param originId {@link String } Unique identifier of the allowed origin. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @throws ApiException if fails to make API call - */ - public void removeAllowedOrigin(String originId, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (originId == null) { - throw new IllegalArgumentException("Please provide the originId path parameter"); - } - pathParams.put("originId", originId); - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/me/allowedOrigins/{originId}", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); - } - - /** - * Get API credential details + * Add allowed origin * - * @return {@link MeApiCredential } + * @param createAllowedOriginRequest {@link CreateAllowedOriginRequest } (required) + * @return {@link AllowedOrigin } * @throws ApiException if fails to make API call */ - public MeApiCredential getApiCredentialDetails() throws ApiException, IOException { - return getApiCredentialDetails(null); + public AllowedOrigin addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest) throws ApiException, IOException { + return addAllowedOrigin(createAllowedOriginRequest, null); } /** - * Get API credential details + * Add allowed origin * + * @param createAllowedOriginRequest {@link CreateAllowedOriginRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link MeApiCredential } + * @return {@link AllowedOrigin } * @throws ApiException if fails to make API call */ - public MeApiCredential getApiCredentialDetails(RequestOptions requestOptions) throws ApiException, IOException { + public AllowedOrigin addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest, RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/me", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null); - return MeApiCredential.fromJson(jsonResult); + String requestBody = createAllowedOriginRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/me/allowedOrigins", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return AllowedOrigin.fromJson(jsonResult); } /** - * Get allowed origins + * Generate a client key * - * @return {@link AllowedOriginsResponse } + * @return {@link GenerateClientKeyResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse getAllowedOrigins() throws ApiException, IOException { - return getAllowedOrigins(null); + public GenerateClientKeyResponse generateClientKey() throws ApiException, IOException { + return generateClientKey(null); } /** - * Get allowed origins + * Generate a client key * * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AllowedOriginsResponse } + * @return {@link GenerateClientKeyResponse } * @throws ApiException if fails to make API call */ - public AllowedOriginsResponse getAllowedOrigins(RequestOptions requestOptions) throws ApiException, IOException { + public GenerateClientKeyResponse generateClientKey(RequestOptions requestOptions) throws ApiException, IOException { String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/me/allowedOrigins", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null); - return AllowedOriginsResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/me/generateClientKey", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return GenerateClientKeyResponse.fromJson(jsonResult); } /** @@ -168,54 +140,82 @@ public AllowedOrigin getAllowedOriginDetails(String originId, RequestOptions req } /** - * Add allowed origin + * Get allowed origins * - * @param createAllowedOriginRequest {@link CreateAllowedOriginRequest } (required) - * @return {@link AllowedOrigin } + * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOrigin addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest) throws ApiException, IOException { - return addAllowedOrigin(createAllowedOriginRequest, null); + public AllowedOriginsResponse getAllowedOrigins() throws ApiException, IOException { + return getAllowedOrigins(null); } /** - * Add allowed origin + * Get allowed origins * - * @param createAllowedOriginRequest {@link CreateAllowedOriginRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link AllowedOrigin } + * @return {@link AllowedOriginsResponse } * @throws ApiException if fails to make API call */ - public AllowedOrigin addAllowedOrigin(CreateAllowedOriginRequest createAllowedOriginRequest, RequestOptions requestOptions) throws ApiException, IOException { + public AllowedOriginsResponse getAllowedOrigins(RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = createAllowedOriginRequest.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/me/allowedOrigins", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return AllowedOrigin.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null); + return AllowedOriginsResponse.fromJson(jsonResult); } /** - * Generate a client key + * Get API credential details * - * @return {@link GenerateClientKeyResponse } + * @return {@link MeApiCredential } * @throws ApiException if fails to make API call */ - public GenerateClientKeyResponse generateClientKey() throws ApiException, IOException { - return generateClientKey(null); + public MeApiCredential getApiCredentialDetails() throws ApiException, IOException { + return getApiCredentialDetails(null); } /** - * Generate a client key + * Get API credential details * * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GenerateClientKeyResponse } + * @return {@link MeApiCredential } * @throws ApiException if fails to make API call */ - public GenerateClientKeyResponse generateClientKey(RequestOptions requestOptions) throws ApiException, IOException { + public MeApiCredential getApiCredentialDetails(RequestOptions requestOptions) throws ApiException, IOException { String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/me/generateClientKey", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return GenerateClientKeyResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/me", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, null); + return MeApiCredential.fromJson(jsonResult); + } + + /** + * Remove allowed origin + * + * @param originId {@link String } Unique identifier of the allowed origin. (required) + * @throws ApiException if fails to make API call + */ + public void removeAllowedOrigin(String originId) throws ApiException, IOException { + removeAllowedOrigin(originId, null); + } + + /** + * Remove allowed origin + * + * @param originId {@link String } Unique identifier of the allowed origin. (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @throws ApiException if fails to make API call + */ + public void removeAllowedOrigin(String originId, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (originId == null) { + throw new IllegalArgumentException("Please provide the originId path parameter"); + } + pathParams.put("originId", originId); + + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/me/allowedOrigins/{originId}", null); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); } } diff --git a/src/main/java/com/adyen/service/management/PaymentMethodsMerchantLevelApi.java b/src/main/java/com/adyen/service/management/PaymentMethodsMerchantLevelApi.java index 50efc89d8..58d867a3d 100644 --- a/src/main/java/com/adyen/service/management/PaymentMethodsMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/PaymentMethodsMerchantLevelApi.java @@ -54,6 +54,44 @@ public PaymentMethodsMerchantLevelApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Add an Apple Pay domain + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) + * @param applePayInfo {@link ApplePayInfo } (required) + * @throws ApiException if fails to make API call + */ + public void addApplePayDomain(String merchantId, String paymentMethodId, ApplePayInfo applePayInfo) throws ApiException, IOException { + addApplePayDomain(merchantId, paymentMethodId, applePayInfo, null); + } + + /** + * Add an Apple Pay domain + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) + * @param applePayInfo {@link ApplePayInfo } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @throws ApiException if fails to make API call + */ + public void addApplePayDomain(String merchantId, String paymentMethodId, ApplePayInfo applePayInfo, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (merchantId == null) { + throw new IllegalArgumentException("Please provide the merchantId path parameter"); + } + pathParams.put("merchantId", merchantId); + if (paymentMethodId == null) { + throw new IllegalArgumentException("Please provide the paymentMethodId path parameter"); + } + pathParams.put("paymentMethodId", paymentMethodId); + + String requestBody = applePayInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains", null); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + } + /** * Get all payment methods * @@ -105,45 +143,6 @@ public PaymentMethodResponse getAllPaymentMethods(String merchantId, String stor return PaymentMethodResponse.fromJson(jsonResult); } - /** - * Get payment method details - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) - * @return {@link PaymentMethod } - * @throws ApiException if fails to make API call - */ - public PaymentMethod getPaymentMethodDetails(String merchantId, String paymentMethodId) throws ApiException, IOException { - return getPaymentMethodDetails(merchantId, paymentMethodId, null); - } - - /** - * Get payment method details - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PaymentMethod } - * @throws ApiException if fails to make API call - */ - public PaymentMethod getPaymentMethodDetails(String merchantId, String paymentMethodId, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (merchantId == null) { - throw new IllegalArgumentException("Please provide the merchantId path parameter"); - } - pathParams.put("merchantId", merchantId); - if (paymentMethodId == null) { - throw new IllegalArgumentException("Please provide the paymentMethodId path parameter"); - } - pathParams.put("paymentMethodId", paymentMethodId); - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return PaymentMethod.fromJson(jsonResult); - } - /** * Get Apple Pay domains * @@ -184,29 +183,27 @@ public ApplePayInfo getApplePayDomains(String merchantId, String paymentMethodId } /** - * Update a payment method + * Get payment method details * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) - * @param updatePaymentMethodInfo {@link UpdatePaymentMethodInfo } (required) * @return {@link PaymentMethod } * @throws ApiException if fails to make API call */ - public PaymentMethod updatePaymentMethod(String merchantId, String paymentMethodId, UpdatePaymentMethodInfo updatePaymentMethodInfo) throws ApiException, IOException { - return updatePaymentMethod(merchantId, paymentMethodId, updatePaymentMethodInfo, null); + public PaymentMethod getPaymentMethodDetails(String merchantId, String paymentMethodId) throws ApiException, IOException { + return getPaymentMethodDetails(merchantId, paymentMethodId, null); } /** - * Update a payment method + * Get payment method details * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) - * @param updatePaymentMethodInfo {@link UpdatePaymentMethodInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link PaymentMethod } * @throws ApiException if fails to make API call */ - public PaymentMethod updatePaymentMethod(String merchantId, String paymentMethodId, UpdatePaymentMethodInfo updatePaymentMethodInfo, RequestOptions requestOptions) throws ApiException, IOException { + public PaymentMethod getPaymentMethodDetails(String merchantId, String paymentMethodId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -218,9 +215,9 @@ public PaymentMethod updatePaymentMethod(String merchantId, String paymentMethod } pathParams.put("paymentMethodId", paymentMethodId); - String requestBody = updatePaymentMethodInfo.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); return PaymentMethod.fromJson(jsonResult); } @@ -260,27 +257,29 @@ public PaymentMethod requestPaymentMethod(String merchantId, PaymentMethodSetupI } /** - * Add an Apple Pay domain + * Update a payment method * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) - * @param applePayInfo {@link ApplePayInfo } (required) + * @param updatePaymentMethodInfo {@link UpdatePaymentMethodInfo } (required) + * @return {@link PaymentMethod } * @throws ApiException if fails to make API call */ - public void addApplePayDomain(String merchantId, String paymentMethodId, ApplePayInfo applePayInfo) throws ApiException, IOException { - addApplePayDomain(merchantId, paymentMethodId, applePayInfo, null); + public PaymentMethod updatePaymentMethod(String merchantId, String paymentMethodId, UpdatePaymentMethodInfo updatePaymentMethodInfo) throws ApiException, IOException { + return updatePaymentMethod(merchantId, paymentMethodId, updatePaymentMethodInfo, null); } /** - * Add an Apple Pay domain + * Update a payment method * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param paymentMethodId {@link String } The unique identifier of the payment method. (required) - * @param applePayInfo {@link ApplePayInfo } (required) + * @param updatePaymentMethodInfo {@link UpdatePaymentMethodInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link PaymentMethod } * @throws ApiException if fails to make API call */ - public void addApplePayDomain(String merchantId, String paymentMethodId, ApplePayInfo applePayInfo, RequestOptions requestOptions) throws ApiException, IOException { + public PaymentMethod updatePaymentMethod(String merchantId, String paymentMethodId, UpdatePaymentMethodInfo updatePaymentMethodInfo, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -292,8 +291,9 @@ public void addApplePayDomain(String merchantId, String paymentMethodId, ApplePa } pathParams.put("paymentMethodId", paymentMethodId); - String requestBody = applePayInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}/addApplePayDomains", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String requestBody = updatePaymentMethodInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return PaymentMethod.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/PayoutSettingsMerchantLevelApi.java b/src/main/java/com/adyen/service/management/PayoutSettingsMerchantLevelApi.java index a499264a5..34b42867f 100644 --- a/src/main/java/com/adyen/service/management/PayoutSettingsMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/PayoutSettingsMerchantLevelApi.java @@ -54,72 +54,74 @@ public PayoutSettingsMerchantLevelApi(Client client, String baseURL) { } /** - * Delete a payout setting + * Add a payout setting * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) + * @param payoutSettingsRequest {@link PayoutSettingsRequest } (required) + * @return {@link PayoutSettings } * @throws ApiException if fails to make API call */ - public void deletePayoutSetting(String merchantId, String payoutSettingsId) throws ApiException, IOException { - deletePayoutSetting(merchantId, payoutSettingsId, null); + public PayoutSettings addPayoutSetting(String merchantId, PayoutSettingsRequest payoutSettingsRequest) throws ApiException, IOException { + return addPayoutSetting(merchantId, payoutSettingsRequest, null); } /** - * Delete a payout setting + * Add a payout setting * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) + * @param payoutSettingsRequest {@link PayoutSettingsRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link PayoutSettings } * @throws ApiException if fails to make API call */ - public void deletePayoutSetting(String merchantId, String payoutSettingsId, RequestOptions requestOptions) throws ApiException, IOException { + public PayoutSettings addPayoutSetting(String merchantId, PayoutSettingsRequest payoutSettingsRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (payoutSettingsId == null) { - throw new IllegalArgumentException("Please provide the payoutSettingsId path parameter"); - } - pathParams.put("payoutSettingsId", payoutSettingsId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings/{payoutSettingsId}", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + String requestBody = payoutSettingsRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return PayoutSettings.fromJson(jsonResult); } /** - * Get a list of payout settings + * Delete a payout setting * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link PayoutSettingsResponse } + * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) * @throws ApiException if fails to make API call */ - public PayoutSettingsResponse listPayoutSettings(String merchantId) throws ApiException, IOException { - return listPayoutSettings(merchantId, null); + public void deletePayoutSetting(String merchantId, String payoutSettingsId) throws ApiException, IOException { + deletePayoutSetting(merchantId, payoutSettingsId, null); } /** - * Get a list of payout settings + * Delete a payout setting * * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PayoutSettingsResponse } * @throws ApiException if fails to make API call */ - public PayoutSettingsResponse listPayoutSettings(String merchantId, RequestOptions requestOptions) throws ApiException, IOException { + public void deletePayoutSetting(String merchantId, String payoutSettingsId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); + if (payoutSettingsId == null) { + throw new IllegalArgumentException("Please provide the payoutSettingsId path parameter"); + } + pathParams.put("payoutSettingsId", payoutSettingsId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return PayoutSettingsResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings/{payoutSettingsId}", null); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); } /** @@ -162,78 +164,76 @@ public PayoutSettings getPayoutSetting(String merchantId, String payoutSettingsI } /** - * Update a payout setting + * Get a list of payout settings * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) - * @param updatePayoutSettingsRequest {@link UpdatePayoutSettingsRequest } (required) - * @return {@link PayoutSettings } + * @return {@link PayoutSettingsResponse } * @throws ApiException if fails to make API call */ - public PayoutSettings updatePayoutSetting(String merchantId, String payoutSettingsId, UpdatePayoutSettingsRequest updatePayoutSettingsRequest) throws ApiException, IOException { - return updatePayoutSetting(merchantId, payoutSettingsId, updatePayoutSettingsRequest, null); + public PayoutSettingsResponse listPayoutSettings(String merchantId) throws ApiException, IOException { + return listPayoutSettings(merchantId, null); } /** - * Update a payout setting + * Get a list of payout settings * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) - * @param updatePayoutSettingsRequest {@link UpdatePayoutSettingsRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link PayoutSettings } + * @return {@link PayoutSettingsResponse } * @throws ApiException if fails to make API call */ - public PayoutSettings updatePayoutSetting(String merchantId, String payoutSettingsId, UpdatePayoutSettingsRequest updatePayoutSettingsRequest, RequestOptions requestOptions) throws ApiException, IOException { + public PayoutSettingsResponse listPayoutSettings(String merchantId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (payoutSettingsId == null) { - throw new IllegalArgumentException("Please provide the payoutSettingsId path parameter"); - } - pathParams.put("payoutSettingsId", payoutSettingsId); - String requestBody = updatePayoutSettingsRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings/{payoutSettingsId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return PayoutSettings.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return PayoutSettingsResponse.fromJson(jsonResult); } /** - * Add a payout setting + * Update a payout setting * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param payoutSettingsRequest {@link PayoutSettingsRequest } (required) + * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) + * @param updatePayoutSettingsRequest {@link UpdatePayoutSettingsRequest } (required) * @return {@link PayoutSettings } * @throws ApiException if fails to make API call */ - public PayoutSettings addPayoutSetting(String merchantId, PayoutSettingsRequest payoutSettingsRequest) throws ApiException, IOException { - return addPayoutSetting(merchantId, payoutSettingsRequest, null); + public PayoutSettings updatePayoutSetting(String merchantId, String payoutSettingsId, UpdatePayoutSettingsRequest updatePayoutSettingsRequest) throws ApiException, IOException { + return updatePayoutSetting(merchantId, payoutSettingsId, updatePayoutSettingsRequest, null); } /** - * Add a payout setting + * Update a payout setting * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param payoutSettingsRequest {@link PayoutSettingsRequest } (required) + * @param payoutSettingsId {@link String } The unique identifier of the payout setting. (required) + * @param updatePayoutSettingsRequest {@link UpdatePayoutSettingsRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link PayoutSettings } * @throws ApiException if fails to make API call */ - public PayoutSettings addPayoutSetting(String merchantId, PayoutSettingsRequest payoutSettingsRequest, RequestOptions requestOptions) throws ApiException, IOException { + public PayoutSettings updatePayoutSetting(String merchantId, String payoutSettingsId, UpdatePayoutSettingsRequest updatePayoutSettingsRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); + if (payoutSettingsId == null) { + throw new IllegalArgumentException("Please provide the payoutSettingsId path parameter"); + } + pathParams.put("payoutSettingsId", payoutSettingsId); - String requestBody = payoutSettingsRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String requestBody = updatePayoutSettingsRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/payoutSettings/{payoutSettingsId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return PayoutSettings.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/SplitConfigurationMerchantLevelApi.java b/src/main/java/com/adyen/service/management/SplitConfigurationMerchantLevelApi.java index 38ab32fdf..e9f365af9 100644 --- a/src/main/java/com/adyen/service/management/SplitConfigurationMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/SplitConfigurationMerchantLevelApi.java @@ -56,27 +56,29 @@ public SplitConfigurationMerchantLevelApi(Client client, String baseURL) { } /** - * Delete a split configuration + * Create a rule * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) + * @param splitConfigurationRule {@link SplitConfigurationRule } (required) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration deleteSplitConfiguration(String merchantId, String splitConfigurationId) throws ApiException, IOException { - return deleteSplitConfiguration(merchantId, splitConfigurationId, null); + public SplitConfiguration createRule(String merchantId, String splitConfigurationId, SplitConfigurationRule splitConfigurationRule) throws ApiException, IOException { + return createRule(merchantId, splitConfigurationId, splitConfigurationRule, null); } /** - * Delete a split configuration + * Create a rule * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) + * @param splitConfigurationRule {@link SplitConfigurationRule } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration deleteSplitConfiguration(String merchantId, String splitConfigurationId, RequestOptions requestOptions) throws ApiException, IOException { + public SplitConfiguration createRule(String merchantId, String splitConfigurationId, SplitConfigurationRule splitConfigurationRule, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -88,36 +90,69 @@ public SplitConfiguration deleteSplitConfiguration(String merchantId, String spl } pathParams.put("splitConfigurationId", splitConfigurationId); - String requestBody = null; + String requestBody = splitConfigurationRule.toJson(); Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); return SplitConfiguration.fromJson(jsonResult); } /** - * Delete a split configuration rule + * Create a split configuration + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param splitConfiguration {@link SplitConfiguration } (required) + * @return {@link SplitConfiguration } + * @throws ApiException if fails to make API call + */ + public SplitConfiguration createSplitConfiguration(String merchantId, SplitConfiguration splitConfiguration) throws ApiException, IOException { + return createSplitConfiguration(merchantId, splitConfiguration, null); + } + + /** + * Create a split configuration + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param splitConfiguration {@link SplitConfiguration } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link SplitConfiguration } + * @throws ApiException if fails to make API call + */ + public SplitConfiguration createSplitConfiguration(String merchantId, SplitConfiguration splitConfiguration, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (merchantId == null) { + throw new IllegalArgumentException("Please provide the merchantId path parameter"); + } + pathParams.put("merchantId", merchantId); + + String requestBody = splitConfiguration.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return SplitConfiguration.fromJson(jsonResult); + } + + /** + * Delete a split configuration * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param ruleId {@link String } (required) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration deleteSplitConfigurationRule(String merchantId, String splitConfigurationId, String ruleId) throws ApiException, IOException { - return deleteSplitConfigurationRule(merchantId, splitConfigurationId, ruleId, null); + public SplitConfiguration deleteSplitConfiguration(String merchantId, String splitConfigurationId) throws ApiException, IOException { + return deleteSplitConfiguration(merchantId, splitConfigurationId, null); } /** - * Delete a split configuration rule + * Delete a split configuration * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param ruleId {@link String } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration deleteSplitConfigurationRule(String merchantId, String splitConfigurationId, String ruleId, RequestOptions requestOptions) throws ApiException, IOException { + public SplitConfiguration deleteSplitConfiguration(String merchantId, String splitConfigurationId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -128,48 +163,56 @@ public SplitConfiguration deleteSplitConfigurationRule(String merchantId, String throw new IllegalArgumentException("Please provide the splitConfigurationId path parameter"); } pathParams.put("splitConfigurationId", splitConfigurationId); - if (ruleId == null) { - throw new IllegalArgumentException("Please provide the ruleId path parameter"); - } - pathParams.put("ruleId", ruleId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}", null); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); return SplitConfiguration.fromJson(jsonResult); } /** - * Get a list of split configurations + * Delete a split configuration rule * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link SplitConfigurationList } + * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) + * @param ruleId {@link String } (required) + * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfigurationList listSplitConfigurations(String merchantId) throws ApiException, IOException { - return listSplitConfigurations(merchantId, null); + public SplitConfiguration deleteSplitConfigurationRule(String merchantId, String splitConfigurationId, String ruleId) throws ApiException, IOException { + return deleteSplitConfigurationRule(merchantId, splitConfigurationId, ruleId, null); } /** - * Get a list of split configurations + * Delete a split configuration rule * * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) + * @param ruleId {@link String } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link SplitConfigurationList } + * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfigurationList listSplitConfigurations(String merchantId, RequestOptions requestOptions) throws ApiException, IOException { + public SplitConfiguration deleteSplitConfigurationRule(String merchantId, String splitConfigurationId, String ruleId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); + if (splitConfigurationId == null) { + throw new IllegalArgumentException("Please provide the splitConfigurationId path parameter"); + } + pathParams.put("splitConfigurationId", splitConfigurationId); + if (ruleId == null) { + throw new IllegalArgumentException("Please provide the ruleId path parameter"); + } + pathParams.put("ruleId", ruleId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return SplitConfigurationList.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + return SplitConfiguration.fromJson(jsonResult); } /** @@ -212,44 +255,36 @@ public SplitConfiguration getSplitConfiguration(String merchantId, String splitC } /** - * Update split configuration description + * Get a list of split configurations * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param updateSplitConfigurationRequest {@link UpdateSplitConfigurationRequest } (required) - * @return {@link SplitConfiguration } + * @return {@link SplitConfigurationList } * @throws ApiException if fails to make API call */ - public SplitConfiguration updateSplitConfigurationDescription(String merchantId, String splitConfigurationId, UpdateSplitConfigurationRequest updateSplitConfigurationRequest) throws ApiException, IOException { - return updateSplitConfigurationDescription(merchantId, splitConfigurationId, updateSplitConfigurationRequest, null); + public SplitConfigurationList listSplitConfigurations(String merchantId) throws ApiException, IOException { + return listSplitConfigurations(merchantId, null); } /** - * Update split configuration description + * Get a list of split configurations * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param updateSplitConfigurationRequest {@link UpdateSplitConfigurationRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link SplitConfiguration } + * @return {@link SplitConfigurationList } * @throws ApiException if fails to make API call */ - public SplitConfiguration updateSplitConfigurationDescription(String merchantId, String splitConfigurationId, UpdateSplitConfigurationRequest updateSplitConfigurationRequest, RequestOptions requestOptions) throws ApiException, IOException { + public SplitConfigurationList listSplitConfigurations(String merchantId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (splitConfigurationId == null) { - throw new IllegalArgumentException("Please provide the splitConfigurationId path parameter"); - } - pathParams.put("splitConfigurationId", splitConfigurationId); - String requestBody = updateSplitConfigurationRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return SplitConfiguration.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return SplitConfigurationList.fromJson(jsonResult); } /** @@ -300,33 +335,29 @@ public SplitConfiguration updateSplitConditions(String merchantId, String splitC } /** - * Update the split logic + * Update split configuration description * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param ruleId {@link String } The unique identifier of the split configuration rule. (required) - * @param splitLogicId {@link String } The unique identifier of the split configuration split. (required) - * @param updateSplitConfigurationLogicRequest {@link UpdateSplitConfigurationLogicRequest } (required) + * @param updateSplitConfigurationRequest {@link UpdateSplitConfigurationRequest } (required) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration updateSplitLogic(String merchantId, String splitConfigurationId, String ruleId, String splitLogicId, UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest) throws ApiException, IOException { - return updateSplitLogic(merchantId, splitConfigurationId, ruleId, splitLogicId, updateSplitConfigurationLogicRequest, null); + public SplitConfiguration updateSplitConfigurationDescription(String merchantId, String splitConfigurationId, UpdateSplitConfigurationRequest updateSplitConfigurationRequest) throws ApiException, IOException { + return updateSplitConfigurationDescription(merchantId, splitConfigurationId, updateSplitConfigurationRequest, null); } /** - * Update the split logic + * Update split configuration description * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param ruleId {@link String } The unique identifier of the split configuration rule. (required) - * @param splitLogicId {@link String } The unique identifier of the split configuration split. (required) - * @param updateSplitConfigurationLogicRequest {@link UpdateSplitConfigurationLogicRequest } (required) + * @param updateSplitConfigurationRequest {@link UpdateSplitConfigurationRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration updateSplitLogic(String merchantId, String splitConfigurationId, String ruleId, String splitLogicId, UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest, RequestOptions requestOptions) throws ApiException, IOException { + public SplitConfiguration updateSplitConfigurationDescription(String merchantId, String splitConfigurationId, UpdateSplitConfigurationRequest updateSplitConfigurationRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -337,80 +368,41 @@ public SplitConfiguration updateSplitLogic(String merchantId, String splitConfig throw new IllegalArgumentException("Please provide the splitConfigurationId path parameter"); } pathParams.put("splitConfigurationId", splitConfigurationId); - if (ruleId == null) { - throw new IllegalArgumentException("Please provide the ruleId path parameter"); - } - pathParams.put("ruleId", ruleId); - if (splitLogicId == null) { - throw new IllegalArgumentException("Please provide the splitLogicId path parameter"); - } - pathParams.put("splitLogicId", splitLogicId); - String requestBody = updateSplitConfigurationLogicRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}", null); + String requestBody = updateSplitConfigurationRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return SplitConfiguration.fromJson(jsonResult); } /** - * Create a split configuration - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param splitConfiguration {@link SplitConfiguration } (required) - * @return {@link SplitConfiguration } - * @throws ApiException if fails to make API call - */ - public SplitConfiguration createSplitConfiguration(String merchantId, SplitConfiguration splitConfiguration) throws ApiException, IOException { - return createSplitConfiguration(merchantId, splitConfiguration, null); - } - - /** - * Create a split configuration - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param splitConfiguration {@link SplitConfiguration } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link SplitConfiguration } - * @throws ApiException if fails to make API call - */ - public SplitConfiguration createSplitConfiguration(String merchantId, SplitConfiguration splitConfiguration, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (merchantId == null) { - throw new IllegalArgumentException("Please provide the merchantId path parameter"); - } - pathParams.put("merchantId", merchantId); - - String requestBody = splitConfiguration.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return SplitConfiguration.fromJson(jsonResult); - } - - /** - * Create a rule + * Update the split logic * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param splitConfigurationRule {@link SplitConfigurationRule } (required) + * @param ruleId {@link String } The unique identifier of the split configuration rule. (required) + * @param splitLogicId {@link String } The unique identifier of the split configuration split. (required) + * @param updateSplitConfigurationLogicRequest {@link UpdateSplitConfigurationLogicRequest } (required) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration createRule(String merchantId, String splitConfigurationId, SplitConfigurationRule splitConfigurationRule) throws ApiException, IOException { - return createRule(merchantId, splitConfigurationId, splitConfigurationRule, null); + public SplitConfiguration updateSplitLogic(String merchantId, String splitConfigurationId, String ruleId, String splitLogicId, UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest) throws ApiException, IOException { + return updateSplitLogic(merchantId, splitConfigurationId, ruleId, splitLogicId, updateSplitConfigurationLogicRequest, null); } /** - * Create a rule + * Update the split logic * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param splitConfigurationId {@link String } The unique identifier of the split configuration. (required) - * @param splitConfigurationRule {@link SplitConfigurationRule } (required) + * @param ruleId {@link String } The unique identifier of the split configuration rule. (required) + * @param splitLogicId {@link String } The unique identifier of the split configuration split. (required) + * @param updateSplitConfigurationLogicRequest {@link UpdateSplitConfigurationLogicRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link SplitConfiguration } * @throws ApiException if fails to make API call */ - public SplitConfiguration createRule(String merchantId, String splitConfigurationId, SplitConfigurationRule splitConfigurationRule, RequestOptions requestOptions) throws ApiException, IOException { + public SplitConfiguration updateSplitLogic(String merchantId, String splitConfigurationId, String ruleId, String splitLogicId, UpdateSplitConfigurationLogicRequest updateSplitConfigurationLogicRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -421,10 +413,18 @@ public SplitConfiguration createRule(String merchantId, String splitConfiguratio throw new IllegalArgumentException("Please provide the splitConfigurationId path parameter"); } pathParams.put("splitConfigurationId", splitConfigurationId); + if (ruleId == null) { + throw new IllegalArgumentException("Please provide the ruleId path parameter"); + } + pathParams.put("ruleId", ruleId); + if (splitLogicId == null) { + throw new IllegalArgumentException("Please provide the splitLogicId path parameter"); + } + pathParams.put("splitLogicId", splitLogicId); - String requestBody = splitConfigurationRule.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String requestBody = updateSplitConfigurationLogicRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/splitConfigurations/{splitConfigurationId}/rules/{ruleId}/splitLogic/{splitLogicId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return SplitConfiguration.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/TerminalActionsCompanyLevelApi.java b/src/main/java/com/adyen/service/management/TerminalActionsCompanyLevelApi.java index ad10bb0df..76b21aae4 100644 --- a/src/main/java/com/adyen/service/management/TerminalActionsCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/TerminalActionsCompanyLevelApi.java @@ -51,6 +51,45 @@ public TerminalActionsCompanyLevelApi(Client client, String baseURL) { this.baseURL = baseURL; } + /** + * Get terminal action + * + * @param companyId {@link String } The unique identifier of the company account. (required) + * @param actionId {@link String } The unique identifier of the terminal action. (required) + * @return {@link ExternalTerminalAction } + * @throws ApiException if fails to make API call + */ + public ExternalTerminalAction getTerminalAction(String companyId, String actionId) throws ApiException, IOException { + return getTerminalAction(companyId, actionId, null); + } + + /** + * Get terminal action + * + * @param companyId {@link String } The unique identifier of the company account. (required) + * @param actionId {@link String } The unique identifier of the terminal action. (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link ExternalTerminalAction } + * @throws ApiException if fails to make API call + */ + public ExternalTerminalAction getTerminalAction(String companyId, String actionId, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (companyId == null) { + throw new IllegalArgumentException("Please provide the companyId path parameter"); + } + pathParams.put("companyId", companyId); + if (actionId == null) { + throw new IllegalArgumentException("Please provide the actionId path parameter"); + } + pathParams.put("actionId", actionId); + + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalActions/{actionId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return ExternalTerminalAction.fromJson(jsonResult); + } + /** * Get a list of terminal actions * @@ -101,43 +140,4 @@ public ListExternalTerminalActionsResponse listTerminalActions(String companyId, String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); return ListExternalTerminalActionsResponse.fromJson(jsonResult); } - - /** - * Get terminal action - * - * @param companyId {@link String } The unique identifier of the company account. (required) - * @param actionId {@link String } The unique identifier of the terminal action. (required) - * @return {@link ExternalTerminalAction } - * @throws ApiException if fails to make API call - */ - public ExternalTerminalAction getTerminalAction(String companyId, String actionId) throws ApiException, IOException { - return getTerminalAction(companyId, actionId, null); - } - - /** - * Get terminal action - * - * @param companyId {@link String } The unique identifier of the company account. (required) - * @param actionId {@link String } The unique identifier of the terminal action. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ExternalTerminalAction } - * @throws ApiException if fails to make API call - */ - public ExternalTerminalAction getTerminalAction(String companyId, String actionId, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (companyId == null) { - throw new IllegalArgumentException("Please provide the companyId path parameter"); - } - pathParams.put("companyId", companyId); - if (actionId == null) { - throw new IllegalArgumentException("Please provide the actionId path parameter"); - } - pathParams.put("actionId", actionId); - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalActions/{actionId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return ExternalTerminalAction.fromJson(jsonResult); - } } diff --git a/src/main/java/com/adyen/service/management/TerminalOrdersCompanyLevelApi.java b/src/main/java/com/adyen/service/management/TerminalOrdersCompanyLevelApi.java index 8d01c46f7..1af636c51 100644 --- a/src/main/java/com/adyen/service/management/TerminalOrdersCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/TerminalOrdersCompanyLevelApi.java @@ -58,111 +58,101 @@ public TerminalOrdersCompanyLevelApi(Client client, String baseURL) { } /** - * Get a list of billing entities + * Cancel an order * * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link BillingEntitiesResponse } + * @param orderId {@link String } The unique identifier of the order. (required) + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public BillingEntitiesResponse listBillingEntities(String companyId) throws ApiException, IOException { - return listBillingEntities(companyId, null, null); + public TerminalOrder cancelOrder(String companyId, String orderId) throws ApiException, IOException { + return cancelOrder(companyId, orderId, null); } /** - * Get a list of billing entities + * Cancel an order * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param name {@link String } Query: The name of the billing entity. (optional) + * @param orderId {@link String } The unique identifier of the order. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BillingEntitiesResponse } + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public BillingEntitiesResponse listBillingEntities(String companyId, String name, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder cancelOrder(String companyId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - //Add query params - Map queryParams = new HashMap<>(); - if (name != null) { - queryParams.put("name", name); + if (orderId == null) { + throw new IllegalArgumentException("Please provide the orderId path parameter"); } + pathParams.put("orderId", orderId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/billingEntities", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return BillingEntitiesResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders/{orderId}/cancel", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return TerminalOrder.fromJson(jsonResult); } /** - * Get a list of shipping locations + * Create an order * * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link ShippingLocationsResponse } + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public ShippingLocationsResponse listShippingLocations(String companyId) throws ApiException, IOException { - return listShippingLocations(companyId, null, null, null, null); + public TerminalOrder createOrder(String companyId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { + return createOrder(companyId, terminalOrderRequest, null); } /** - * Get a list of shipping locations + * Create an order * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param name {@link String } Query: The name of the shipping location. (optional) - * @param offset {@link Integer } Query: The number of locations to skip. (optional) - * @param limit {@link Integer } Query: The number of locations to return. (optional) + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ShippingLocationsResponse } + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public ShippingLocationsResponse listShippingLocations(String companyId, String name, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder createOrder(String companyId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - //Add query params - Map queryParams = new HashMap<>(); - if (name != null) { - queryParams.put("name", name); - } - if (offset != null) { - queryParams.put("offset", offset.toString()); - } - if (limit != null) { - queryParams.put("limit", limit.toString()); - } - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/shippingLocations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ShippingLocationsResponse.fromJson(jsonResult); + String requestBody = terminalOrderRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return TerminalOrder.fromJson(jsonResult); } /** - * Get a list of terminal models + * Create a shipping location * * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link TerminalModelsResponse } + * @param shippingLocation {@link ShippingLocation } (required) + * @return {@link ShippingLocation } * @throws ApiException if fails to make API call */ - public TerminalModelsResponse listTerminalModels(String companyId) throws ApiException, IOException { - return listTerminalModels(companyId, null); + public ShippingLocation createShippingLocation(String companyId, ShippingLocation shippingLocation) throws ApiException, IOException { + return createShippingLocation(companyId, shippingLocation, null); } /** - * Get a list of terminal models + * Create a shipping location * * @param companyId {@link String } The unique identifier of the company account. (required) + * @param shippingLocation {@link ShippingLocation } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalModelsResponse } + * @return {@link ShippingLocation } * @throws ApiException if fails to make API call */ - public TerminalModelsResponse listTerminalModels(String companyId, RequestOptions requestOptions) throws ApiException, IOException { + public ShippingLocation createShippingLocation(String companyId, ShippingLocation shippingLocation, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -170,127 +160,114 @@ public TerminalModelsResponse listTerminalModels(String companyId, RequestOption } pathParams.put("companyId", companyId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalModels", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return TerminalModelsResponse.fromJson(jsonResult); + String requestBody = shippingLocation.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/shippingLocations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return ShippingLocation.fromJson(jsonResult); } /** - * Get a list of orders + * Get an order * * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link TerminalOrdersResponse } + * @param orderId {@link String } The unique identifier of the order. (required) + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrdersResponse listOrders(String companyId) throws ApiException, IOException { - return listOrders(companyId, null, null, null, null, null); + public TerminalOrder getOrder(String companyId, String orderId) throws ApiException, IOException { + return getOrder(companyId, orderId, null); } /** - * Get a list of orders + * Get an order * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param customerOrderReference {@link String } Query: Your purchase order number. (optional) - * @param status {@link String } Query: The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. (optional) - * @param offset {@link Integer } Query: The number of orders to skip. (optional) - * @param limit {@link Integer } Query: The number of orders to return. (optional) + * @param orderId {@link String } The unique identifier of the order. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrdersResponse } + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrdersResponse listOrders(String companyId, String customerOrderReference, String status, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder getOrder(String companyId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - //Add query params - Map queryParams = new HashMap<>(); - if (customerOrderReference != null) { - queryParams.put("customerOrderReference", customerOrderReference); - } - if (status != null) { - queryParams.put("status", status); - } - if (offset != null) { - queryParams.put("offset", offset.toString()); - } - if (limit != null) { - queryParams.put("limit", limit.toString()); + if (orderId == null) { + throw new IllegalArgumentException("Please provide the orderId path parameter"); } + pathParams.put("orderId", orderId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return TerminalOrdersResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders/{orderId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return TerminalOrder.fromJson(jsonResult); } /** - * Get an order + * Get a list of billing entities * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) - * @return {@link TerminalOrder } + * @return {@link BillingEntitiesResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder getOrder(String companyId, String orderId) throws ApiException, IOException { - return getOrder(companyId, orderId, null); + public BillingEntitiesResponse listBillingEntities(String companyId) throws ApiException, IOException { + return listBillingEntities(companyId, null, null); } /** - * Get an order + * Get a list of billing entities * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) + * @param name {@link String } Query: The name of the billing entity. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrder } + * @return {@link BillingEntitiesResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder getOrder(String companyId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { + public BillingEntitiesResponse listBillingEntities(String companyId, String name, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - if (orderId == null) { - throw new IllegalArgumentException("Please provide the orderId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (name != null) { + queryParams.put("name", name); } - pathParams.put("orderId", orderId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders/{orderId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return TerminalOrder.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/billingEntities", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return BillingEntitiesResponse.fromJson(jsonResult); } /** - * Get a list of terminal products + * Get a list of orders * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param country {@link String } The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) - * @return {@link TerminalProductsResponse } + * @return {@link TerminalOrdersResponse } * @throws ApiException if fails to make API call */ - public TerminalProductsResponse listTerminalProducts(String companyId, String country) throws ApiException, IOException { - return listTerminalProducts(companyId, country, null, null, null, null); + public TerminalOrdersResponse listOrders(String companyId) throws ApiException, IOException { + return listOrders(companyId, null, null, null, null, null); } /** - * Get a list of terminal products + * Get a list of orders * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param country {@link String } Query: The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) - * @param terminalModelId {@link String } Query: The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400** (optional) - * @param offset {@link Integer } Query: The number of products to skip. (optional) - * @param limit {@link Integer } Query: The number of products to return. (optional) + * @param customerOrderReference {@link String } Query: Your purchase order number. (optional) + * @param status {@link String } Query: The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. (optional) + * @param offset {@link Integer } Query: The number of orders to skip. (optional) + * @param limit {@link Integer } Query: The number of orders to return. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalProductsResponse } + * @return {@link TerminalOrdersResponse } * @throws ApiException if fails to make API call */ - public TerminalProductsResponse listTerminalProducts(String companyId, String country, String terminalModelId, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrdersResponse listOrders(String companyId, String customerOrderReference, String status, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -299,11 +276,11 @@ public TerminalProductsResponse listTerminalProducts(String companyId, String co pathParams.put("companyId", companyId); //Add query params Map queryParams = new HashMap<>(); - if (country != null) { - queryParams.put("country", country); + if (customerOrderReference != null) { + queryParams.put("customerOrderReference", customerOrderReference); } - if (terminalModelId != null) { - queryParams.put("terminalModelId", terminalModelId); + if (status != null) { + queryParams.put("status", status); } if (offset != null) { queryParams.put("offset", offset.toString()); @@ -313,74 +290,78 @@ public TerminalProductsResponse listTerminalProducts(String companyId, String co } String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalProducts", null); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return TerminalProductsResponse.fromJson(jsonResult); + return TerminalOrdersResponse.fromJson(jsonResult); } /** - * Update an order + * Get a list of shipping locations * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) - * @return {@link TerminalOrder } + * @return {@link ShippingLocationsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder updateOrder(String companyId, String orderId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { - return updateOrder(companyId, orderId, terminalOrderRequest, null); + public ShippingLocationsResponse listShippingLocations(String companyId) throws ApiException, IOException { + return listShippingLocations(companyId, null, null, null, null); } /** - * Update an order + * Get a list of shipping locations * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) + * @param name {@link String } Query: The name of the shipping location. (optional) + * @param offset {@link Integer } Query: The number of locations to skip. (optional) + * @param limit {@link Integer } Query: The number of locations to return. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrder } + * @return {@link ShippingLocationsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder updateOrder(String companyId, String orderId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ShippingLocationsResponse listShippingLocations(String companyId, String name, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - if (orderId == null) { - throw new IllegalArgumentException("Please provide the orderId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (name != null) { + queryParams.put("name", name); + } + if (offset != null) { + queryParams.put("offset", offset.toString()); + } + if (limit != null) { + queryParams.put("limit", limit.toString()); } - pathParams.put("orderId", orderId); - String requestBody = terminalOrderRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders/{orderId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return TerminalOrder.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/shippingLocations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ShippingLocationsResponse.fromJson(jsonResult); } /** - * Create a shipping location + * Get a list of terminal models * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param shippingLocation {@link ShippingLocation } (required) - * @return {@link ShippingLocation } + * @return {@link TerminalModelsResponse } * @throws ApiException if fails to make API call */ - public ShippingLocation createShippingLocation(String companyId, ShippingLocation shippingLocation) throws ApiException, IOException { - return createShippingLocation(companyId, shippingLocation, null); + public TerminalModelsResponse listTerminalModels(String companyId) throws ApiException, IOException { + return listTerminalModels(companyId, null); } /** - * Create a shipping location + * Get a list of terminal models * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param shippingLocation {@link ShippingLocation } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ShippingLocation } + * @return {@link TerminalModelsResponse } * @throws ApiException if fails to make API call */ - public ShippingLocation createShippingLocation(String companyId, ShippingLocation shippingLocation, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalModelsResponse listTerminalModels(String companyId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -388,69 +369,88 @@ public ShippingLocation createShippingLocation(String companyId, ShippingLocatio } pathParams.put("companyId", companyId); - String requestBody = shippingLocation.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/shippingLocations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return ShippingLocation.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalModels", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return TerminalModelsResponse.fromJson(jsonResult); } /** - * Create an order + * Get a list of terminal products * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) - * @return {@link TerminalOrder } + * @param country {@link String } The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) + * @return {@link TerminalProductsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder createOrder(String companyId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { - return createOrder(companyId, terminalOrderRequest, null); + public TerminalProductsResponse listTerminalProducts(String companyId, String country) throws ApiException, IOException { + return listTerminalProducts(companyId, country, null, null, null, null); } /** - * Create an order + * Get a list of terminal products * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) + * @param country {@link String } Query: The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) + * @param terminalModelId {@link String } Query: The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/companies/{companyId}/terminalModels) response. For example, **Verifone.M400** (optional) + * @param offset {@link Integer } Query: The number of products to skip. (optional) + * @param limit {@link Integer } Query: The number of products to return. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrder } + * @return {@link TerminalProductsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder createOrder(String companyId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalProductsResponse listTerminalProducts(String companyId, String country, String terminalModelId, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); + //Add query params + Map queryParams = new HashMap<>(); + if (country != null) { + queryParams.put("country", country); + } + if (terminalModelId != null) { + queryParams.put("terminalModelId", terminalModelId); + } + if (offset != null) { + queryParams.put("offset", offset.toString()); + } + if (limit != null) { + queryParams.put("limit", limit.toString()); + } - String requestBody = terminalOrderRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return TerminalOrder.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalProducts", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return TerminalProductsResponse.fromJson(jsonResult); } /** - * Cancel an order + * Update an order * * @param companyId {@link String } The unique identifier of the company account. (required) * @param orderId {@link String } The unique identifier of the order. (required) + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrder cancelOrder(String companyId, String orderId) throws ApiException, IOException { - return cancelOrder(companyId, orderId, null); + public TerminalOrder updateOrder(String companyId, String orderId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { + return updateOrder(companyId, orderId, terminalOrderRequest, null); } /** - * Cancel an order + * Update an order * * @param companyId {@link String } The unique identifier of the company account. (required) * @param orderId {@link String } The unique identifier of the order. (required) + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrder cancelOrder(String companyId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder updateOrder(String companyId, String orderId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -462,9 +462,9 @@ public TerminalOrder cancelOrder(String companyId, String orderId, RequestOption } pathParams.put("orderId", orderId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders/{orderId}/cancel", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String requestBody = terminalOrderRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/terminalOrders/{orderId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return TerminalOrder.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/TerminalOrdersMerchantLevelApi.java b/src/main/java/com/adyen/service/management/TerminalOrdersMerchantLevelApi.java index 8bba2874f..3a1cd010e 100644 --- a/src/main/java/com/adyen/service/management/TerminalOrdersMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/TerminalOrdersMerchantLevelApi.java @@ -58,111 +58,101 @@ public TerminalOrdersMerchantLevelApi(Client client, String baseURL) { } /** - * Get a list of billing entities + * Cancel an order * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link BillingEntitiesResponse } + * @param orderId {@link String } The unique identifier of the order. (required) + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public BillingEntitiesResponse listBillingEntities(String merchantId) throws ApiException, IOException { - return listBillingEntities(merchantId, null, null); + public TerminalOrder cancelOrder(String merchantId, String orderId) throws ApiException, IOException { + return cancelOrder(merchantId, orderId, null); } /** - * Get a list of billing entities + * Cancel an order * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param name {@link String } Query: The name of the billing entity. (optional) + * @param orderId {@link String } The unique identifier of the order. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link BillingEntitiesResponse } + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public BillingEntitiesResponse listBillingEntities(String merchantId, String name, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder cancelOrder(String merchantId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (name != null) { - queryParams.put("name", name); + if (orderId == null) { + throw new IllegalArgumentException("Please provide the orderId path parameter"); } + pathParams.put("orderId", orderId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/billingEntities", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return BillingEntitiesResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders/{orderId}/cancel", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return TerminalOrder.fromJson(jsonResult); } /** - * Get a list of shipping locations + * Create an order * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link ShippingLocationsResponse } + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public ShippingLocationsResponse listShippingLocations(String merchantId) throws ApiException, IOException { - return listShippingLocations(merchantId, null, null, null, null); + public TerminalOrder createOrder(String merchantId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { + return createOrder(merchantId, terminalOrderRequest, null); } /** - * Get a list of shipping locations + * Create an order * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param name {@link String } Query: The name of the shipping location. (optional) - * @param offset {@link Integer } Query: The number of locations to skip. (optional) - * @param limit {@link Integer } Query: The number of locations to return. (optional) + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ShippingLocationsResponse } + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public ShippingLocationsResponse listShippingLocations(String merchantId, String name, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder createOrder(String merchantId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (name != null) { - queryParams.put("name", name); - } - if (offset != null) { - queryParams.put("offset", offset.toString()); - } - if (limit != null) { - queryParams.put("limit", limit.toString()); - } - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/shippingLocations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ShippingLocationsResponse.fromJson(jsonResult); + String requestBody = terminalOrderRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return TerminalOrder.fromJson(jsonResult); } /** - * Get a list of terminal models + * Create a shipping location * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link TerminalModelsResponse } + * @param shippingLocation {@link ShippingLocation } (required) + * @return {@link ShippingLocation } * @throws ApiException if fails to make API call */ - public TerminalModelsResponse listTerminalModels(String merchantId) throws ApiException, IOException { - return listTerminalModels(merchantId, null); + public ShippingLocation createShippingLocation(String merchantId, ShippingLocation shippingLocation) throws ApiException, IOException { + return createShippingLocation(merchantId, shippingLocation, null); } /** - * Get a list of terminal models + * Create a shipping location * * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param shippingLocation {@link ShippingLocation } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalModelsResponse } + * @return {@link ShippingLocation } * @throws ApiException if fails to make API call */ - public TerminalModelsResponse listTerminalModels(String merchantId, RequestOptions requestOptions) throws ApiException, IOException { + public ShippingLocation createShippingLocation(String merchantId, ShippingLocation shippingLocation, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -170,127 +160,114 @@ public TerminalModelsResponse listTerminalModels(String merchantId, RequestOptio } pathParams.put("merchantId", merchantId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalModels", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return TerminalModelsResponse.fromJson(jsonResult); + String requestBody = shippingLocation.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/shippingLocations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return ShippingLocation.fromJson(jsonResult); } /** - * Get a list of orders + * Get an order * - * @param merchantId {@link String } (required) - * @return {@link TerminalOrdersResponse } + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param orderId {@link String } The unique identifier of the order. (required) + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrdersResponse listOrders(String merchantId) throws ApiException, IOException { - return listOrders(merchantId, null, null, null, null, null); + public TerminalOrder getOrder(String merchantId, String orderId) throws ApiException, IOException { + return getOrder(merchantId, orderId, null); } /** - * Get a list of orders + * Get an order * - * @param merchantId {@link String } (required) - * @param customerOrderReference {@link String } Query: Your purchase order number. (optional) - * @param status {@link String } Query: The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. (optional) - * @param offset {@link Integer } Query: The number of orders to skip. (optional) - * @param limit {@link Integer } Query: The number of orders to return. (optional) + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param orderId {@link String } The unique identifier of the order. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrdersResponse } + * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrdersResponse listOrders(String merchantId, String customerOrderReference, String status, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder getOrder(String merchantId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (customerOrderReference != null) { - queryParams.put("customerOrderReference", customerOrderReference); - } - if (status != null) { - queryParams.put("status", status); - } - if (offset != null) { - queryParams.put("offset", offset.toString()); - } - if (limit != null) { - queryParams.put("limit", limit.toString()); + if (orderId == null) { + throw new IllegalArgumentException("Please provide the orderId path parameter"); } + pathParams.put("orderId", orderId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return TerminalOrdersResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders/{orderId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return TerminalOrder.fromJson(jsonResult); } /** - * Get an order + * Get a list of billing entities * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) - * @return {@link TerminalOrder } + * @return {@link BillingEntitiesResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder getOrder(String merchantId, String orderId) throws ApiException, IOException { - return getOrder(merchantId, orderId, null); + public BillingEntitiesResponse listBillingEntities(String merchantId) throws ApiException, IOException { + return listBillingEntities(merchantId, null, null); } /** - * Get an order + * Get a list of billing entities * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) + * @param name {@link String } Query: The name of the billing entity. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrder } + * @return {@link BillingEntitiesResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder getOrder(String merchantId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { + public BillingEntitiesResponse listBillingEntities(String merchantId, String name, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (orderId == null) { - throw new IllegalArgumentException("Please provide the orderId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (name != null) { + queryParams.put("name", name); } - pathParams.put("orderId", orderId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders/{orderId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return TerminalOrder.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/billingEntities", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return BillingEntitiesResponse.fromJson(jsonResult); } /** - * Get a list of terminal products + * Get a list of orders * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param country {@link String } The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) - * @return {@link TerminalProductsResponse } + * @param merchantId {@link String } (required) + * @return {@link TerminalOrdersResponse } * @throws ApiException if fails to make API call */ - public TerminalProductsResponse listTerminalProducts(String merchantId, String country) throws ApiException, IOException { - return listTerminalProducts(merchantId, country, null, null, null, null); + public TerminalOrdersResponse listOrders(String merchantId) throws ApiException, IOException { + return listOrders(merchantId, null, null, null, null, null); } /** - * Get a list of terminal products + * Get a list of orders * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param country {@link String } Query: The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) - * @param terminalModelId {@link String } Query: The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400** (optional) - * @param offset {@link Integer } Query: The number of products to skip. (optional) - * @param limit {@link Integer } Query: The number of products to return. (optional) + * @param merchantId {@link String } (required) + * @param customerOrderReference {@link String } Query: Your purchase order number. (optional) + * @param status {@link String } Query: The order status. Possible values (not case-sensitive): Placed, Confirmed, Cancelled, Shipped, Delivered. (optional) + * @param offset {@link Integer } Query: The number of orders to skip. (optional) + * @param limit {@link Integer } Query: The number of orders to return. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalProductsResponse } + * @return {@link TerminalOrdersResponse } * @throws ApiException if fails to make API call */ - public TerminalProductsResponse listTerminalProducts(String merchantId, String country, String terminalModelId, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrdersResponse listOrders(String merchantId, String customerOrderReference, String status, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -299,11 +276,11 @@ public TerminalProductsResponse listTerminalProducts(String merchantId, String c pathParams.put("merchantId", merchantId); //Add query params Map queryParams = new HashMap<>(); - if (country != null) { - queryParams.put("country", country); + if (customerOrderReference != null) { + queryParams.put("customerOrderReference", customerOrderReference); } - if (terminalModelId != null) { - queryParams.put("terminalModelId", terminalModelId); + if (status != null) { + queryParams.put("status", status); } if (offset != null) { queryParams.put("offset", offset.toString()); @@ -313,74 +290,78 @@ public TerminalProductsResponse listTerminalProducts(String merchantId, String c } String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalProducts", null); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return TerminalProductsResponse.fromJson(jsonResult); + return TerminalOrdersResponse.fromJson(jsonResult); } /** - * Update an order + * Get a list of shipping locations * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) - * @return {@link TerminalOrder } + * @return {@link ShippingLocationsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder updateOrder(String merchantId, String orderId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { - return updateOrder(merchantId, orderId, terminalOrderRequest, null); + public ShippingLocationsResponse listShippingLocations(String merchantId) throws ApiException, IOException { + return listShippingLocations(merchantId, null, null, null, null); } /** - * Update an order + * Get a list of shipping locations * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param orderId {@link String } The unique identifier of the order. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) + * @param name {@link String } Query: The name of the shipping location. (optional) + * @param offset {@link Integer } Query: The number of locations to skip. (optional) + * @param limit {@link Integer } Query: The number of locations to return. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrder } + * @return {@link ShippingLocationsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder updateOrder(String merchantId, String orderId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ShippingLocationsResponse listShippingLocations(String merchantId, String name, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (orderId == null) { - throw new IllegalArgumentException("Please provide the orderId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (name != null) { + queryParams.put("name", name); + } + if (offset != null) { + queryParams.put("offset", offset.toString()); + } + if (limit != null) { + queryParams.put("limit", limit.toString()); } - pathParams.put("orderId", orderId); - String requestBody = terminalOrderRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders/{orderId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return TerminalOrder.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/shippingLocations", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ShippingLocationsResponse.fromJson(jsonResult); } /** - * Create a shipping location + * Get a list of terminal models * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param shippingLocation {@link ShippingLocation } (required) - * @return {@link ShippingLocation } + * @return {@link TerminalModelsResponse } * @throws ApiException if fails to make API call */ - public ShippingLocation createShippingLocation(String merchantId, ShippingLocation shippingLocation) throws ApiException, IOException { - return createShippingLocation(merchantId, shippingLocation, null); + public TerminalModelsResponse listTerminalModels(String merchantId) throws ApiException, IOException { + return listTerminalModels(merchantId, null); } /** - * Create a shipping location + * Get a list of terminal models * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param shippingLocation {@link ShippingLocation } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ShippingLocation } + * @return {@link TerminalModelsResponse } * @throws ApiException if fails to make API call */ - public ShippingLocation createShippingLocation(String merchantId, ShippingLocation shippingLocation, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalModelsResponse listTerminalModels(String merchantId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -388,69 +369,88 @@ public ShippingLocation createShippingLocation(String merchantId, ShippingLocati } pathParams.put("merchantId", merchantId); - String requestBody = shippingLocation.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/shippingLocations", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return ShippingLocation.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalModels", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return TerminalModelsResponse.fromJson(jsonResult); } /** - * Create an order + * Get a list of terminal products * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) - * @return {@link TerminalOrder } + * @param country {@link String } The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) + * @return {@link TerminalProductsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder createOrder(String merchantId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { - return createOrder(merchantId, terminalOrderRequest, null); + public TerminalProductsResponse listTerminalProducts(String merchantId, String country) throws ApiException, IOException { + return listTerminalProducts(merchantId, country, null, null, null, null); } /** - * Create an order + * Get a list of terminal products * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param terminalOrderRequest {@link TerminalOrderRequest } (required) + * @param country {@link String } Query: The country to return products for, in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **US** (required) + * @param terminalModelId {@link String } Query: The terminal model to return products for. Use the ID returned in the [GET `/terminalModels`](https://docs.adyen.com/api-explorer/#/ManagementService/latest/get/merchants/{merchantId}/terminalModels) response. For example, **Verifone.M400** (optional) + * @param offset {@link Integer } Query: The number of products to skip. (optional) + * @param limit {@link Integer } Query: The number of products to return. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalOrder } + * @return {@link TerminalProductsResponse } * @throws ApiException if fails to make API call */ - public TerminalOrder createOrder(String merchantId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalProductsResponse listTerminalProducts(String merchantId, String country, String terminalModelId, Integer offset, Integer limit, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); + //Add query params + Map queryParams = new HashMap<>(); + if (country != null) { + queryParams.put("country", country); + } + if (terminalModelId != null) { + queryParams.put("terminalModelId", terminalModelId); + } + if (offset != null) { + queryParams.put("offset", offset.toString()); + } + if (limit != null) { + queryParams.put("limit", limit.toString()); + } - String requestBody = terminalOrderRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return TerminalOrder.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalProducts", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return TerminalProductsResponse.fromJson(jsonResult); } /** - * Cancel an order + * Update an order * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param orderId {@link String } The unique identifier of the order. (required) + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrder cancelOrder(String merchantId, String orderId) throws ApiException, IOException { - return cancelOrder(merchantId, orderId, null); + public TerminalOrder updateOrder(String merchantId, String orderId, TerminalOrderRequest terminalOrderRequest) throws ApiException, IOException { + return updateOrder(merchantId, orderId, terminalOrderRequest, null); } /** - * Cancel an order + * Update an order * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param orderId {@link String } The unique identifier of the order. (required) + * @param terminalOrderRequest {@link TerminalOrderRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link TerminalOrder } * @throws ApiException if fails to make API call */ - public TerminalOrder cancelOrder(String merchantId, String orderId, RequestOptions requestOptions) throws ApiException, IOException { + public TerminalOrder updateOrder(String merchantId, String orderId, TerminalOrderRequest terminalOrderRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -462,9 +462,9 @@ public TerminalOrder cancelOrder(String merchantId, String orderId, RequestOptio } pathParams.put("orderId", orderId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders/{orderId}/cancel", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + String requestBody = terminalOrderRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/terminalOrders/{orderId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); return TerminalOrder.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/TerminalSettingsStoreLevelApi.java b/src/main/java/com/adyen/service/management/TerminalSettingsStoreLevelApi.java index 355abc9c0..7dff45089 100644 --- a/src/main/java/com/adyen/service/management/TerminalSettingsStoreLevelApi.java +++ b/src/main/java/com/adyen/service/management/TerminalSettingsStoreLevelApi.java @@ -97,45 +97,6 @@ public Logo getTerminalLogo(String merchantId, String reference, String model, R return Logo.fromJson(jsonResult); } - /** - * Get terminal settings - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param reference {@link String } The reference that identifies the store. (required) - * @return {@link TerminalSettings } - * @throws ApiException if fails to make API call - */ - public TerminalSettings getTerminalSettings(String merchantId, String reference) throws ApiException, IOException { - return getTerminalSettings(merchantId, reference, null); - } - - /** - * Get terminal settings - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param reference {@link String } The reference that identifies the store. (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalSettings } - * @throws ApiException if fails to make API call - */ - public TerminalSettings getTerminalSettings(String merchantId, String reference, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (merchantId == null) { - throw new IllegalArgumentException("Please provide the merchantId path parameter"); - } - pathParams.put("merchantId", merchantId); - if (reference == null) { - throw new IllegalArgumentException("Please provide the reference path parameter"); - } - pathParams.put("reference", reference); - - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores/{reference}/terminalSettings", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return TerminalSettings.fromJson(jsonResult); - } - /** * Get the terminal logo * @@ -176,6 +137,45 @@ public Logo getTerminalLogoByStoreId(String storeId, String model, RequestOption return Logo.fromJson(jsonResult); } + /** + * Get terminal settings + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param reference {@link String } The reference that identifies the store. (required) + * @return {@link TerminalSettings } + * @throws ApiException if fails to make API call + */ + public TerminalSettings getTerminalSettings(String merchantId, String reference) throws ApiException, IOException { + return getTerminalSettings(merchantId, reference, null); + } + + /** + * Get terminal settings + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param reference {@link String } The reference that identifies the store. (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link TerminalSettings } + * @throws ApiException if fails to make API call + */ + public TerminalSettings getTerminalSettings(String merchantId, String reference, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (merchantId == null) { + throw new IllegalArgumentException("Please provide the merchantId path parameter"); + } + pathParams.put("merchantId", merchantId); + if (reference == null) { + throw new IllegalArgumentException("Please provide the reference path parameter"); + } + pathParams.put("reference", reference); + + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores/{reference}/terminalSettings", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return TerminalSettings.fromJson(jsonResult); + } + /** * Get terminal settings * @@ -257,47 +257,6 @@ public Logo updateTerminalLogo(String merchantId, String reference, String model return Logo.fromJson(jsonResult); } - /** - * Update terminal settings - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param reference {@link String } The reference that identifies the store. (required) - * @param terminalSettings {@link TerminalSettings } (required) - * @return {@link TerminalSettings } - * @throws ApiException if fails to make API call - */ - public TerminalSettings updateTerminalSettings(String merchantId, String reference, TerminalSettings terminalSettings) throws ApiException, IOException { - return updateTerminalSettings(merchantId, reference, terminalSettings, null); - } - - /** - * Update terminal settings - * - * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param reference {@link String } The reference that identifies the store. (required) - * @param terminalSettings {@link TerminalSettings } (required) - * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TerminalSettings } - * @throws ApiException if fails to make API call - */ - public TerminalSettings updateTerminalSettings(String merchantId, String reference, TerminalSettings terminalSettings, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (merchantId == null) { - throw new IllegalArgumentException("Please provide the merchantId path parameter"); - } - pathParams.put("merchantId", merchantId); - if (reference == null) { - throw new IllegalArgumentException("Please provide the reference path parameter"); - } - pathParams.put("reference", reference); - - String requestBody = terminalSettings.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores/{reference}/terminalSettings", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return TerminalSettings.fromJson(jsonResult); - } - /** * Update the terminal logo * @@ -340,6 +299,47 @@ public Logo updateTerminalLogoByStoreId(String storeId, String model, Logo logo, return Logo.fromJson(jsonResult); } + /** + * Update terminal settings + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param reference {@link String } The reference that identifies the store. (required) + * @param terminalSettings {@link TerminalSettings } (required) + * @return {@link TerminalSettings } + * @throws ApiException if fails to make API call + */ + public TerminalSettings updateTerminalSettings(String merchantId, String reference, TerminalSettings terminalSettings) throws ApiException, IOException { + return updateTerminalSettings(merchantId, reference, terminalSettings, null); + } + + /** + * Update terminal settings + * + * @param merchantId {@link String } The unique identifier of the merchant account. (required) + * @param reference {@link String } The reference that identifies the store. (required) + * @param terminalSettings {@link TerminalSettings } (required) + * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link TerminalSettings } + * @throws ApiException if fails to make API call + */ + public TerminalSettings updateTerminalSettings(String merchantId, String reference, TerminalSettings terminalSettings, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (merchantId == null) { + throw new IllegalArgumentException("Please provide the merchantId path parameter"); + } + pathParams.put("merchantId", merchantId); + if (reference == null) { + throw new IllegalArgumentException("Please provide the reference path parameter"); + } + pathParams.put("reference", reference); + + String requestBody = terminalSettings.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/stores/{reference}/terminalSettings", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return TerminalSettings.fromJson(jsonResult); + } + /** * Update terminal settings * diff --git a/src/main/java/com/adyen/service/management/UsersCompanyLevelApi.java b/src/main/java/com/adyen/service/management/UsersCompanyLevelApi.java index 69cc25d8c..e48d9ac73 100644 --- a/src/main/java/com/adyen/service/management/UsersCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/UsersCompanyLevelApi.java @@ -55,50 +55,38 @@ public UsersCompanyLevelApi(Client client, String baseURL) { } /** - * Get a list of users + * Create a new user * * @param companyId {@link String } The unique identifier of the company account. (required) - * @return {@link ListCompanyUsersResponse } + * @param createCompanyUserRequest {@link CreateCompanyUserRequest } (required) + * @return {@link CreateCompanyUserResponse } * @throws ApiException if fails to make API call */ - public ListCompanyUsersResponse listUsers(String companyId) throws ApiException, IOException { - return listUsers(companyId, null, null, null, null); + public CreateCompanyUserResponse createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest) throws ApiException, IOException { + return createNewUser(companyId, createCompanyUserRequest, null); } /** - * Get a list of users + * Create a new user * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param pageNumber {@link Integer } Query: The number of the page to return. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page. (optional) - * @param username {@link String } Query: The partial or complete username to select all users that match. (optional) + * @param createCompanyUserRequest {@link CreateCompanyUserRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListCompanyUsersResponse } + * @return {@link CreateCompanyUserResponse } * @throws ApiException if fails to make API call */ - public ListCompanyUsersResponse listUsers(String companyId, Integer pageNumber, Integer pageSize, String username, RequestOptions requestOptions) throws ApiException, IOException { + public CreateCompanyUserResponse createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); - } - if (username != null) { - queryParams.put("username", username); - } - String requestBody = null; + String requestBody = createCompanyUserRequest.toJson(); Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/users", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListCompanyUsersResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return CreateCompanyUserResponse.fromJson(jsonResult); } /** @@ -141,78 +129,90 @@ public CompanyUser getUserDetails(String companyId, String userId, RequestOption } /** - * Update user details + * Get a list of users * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param userId {@link String } The unique identifier of the user. (required) - * @param updateCompanyUserRequest {@link UpdateCompanyUserRequest } (required) - * @return {@link CompanyUser } + * @return {@link ListCompanyUsersResponse } * @throws ApiException if fails to make API call */ - public CompanyUser updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest) throws ApiException, IOException { - return updateUserDetails(companyId, userId, updateCompanyUserRequest, null); + public ListCompanyUsersResponse listUsers(String companyId) throws ApiException, IOException { + return listUsers(companyId, null, null, null, null); } /** - * Update user details + * Get a list of users * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param userId {@link String } The unique identifier of the user. (required) - * @param updateCompanyUserRequest {@link UpdateCompanyUserRequest } (required) + * @param pageNumber {@link Integer } Query: The number of the page to return. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page. (optional) + * @param username {@link String } Query: The partial or complete username to select all users that match. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CompanyUser } + * @return {@link ListCompanyUsersResponse } * @throws ApiException if fails to make API call */ - public CompanyUser updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ListCompanyUsersResponse listUsers(String companyId, Integer pageNumber, Integer pageSize, String username, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - if (userId == null) { - throw new IllegalArgumentException("Please provide the userId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); + } + if (username != null) { + queryParams.put("username", username); } - pathParams.put("userId", userId); - String requestBody = updateCompanyUserRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/users/{userId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return CompanyUser.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/users", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListCompanyUsersResponse.fromJson(jsonResult); } /** - * Create a new user + * Update user details * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param createCompanyUserRequest {@link CreateCompanyUserRequest } (required) - * @return {@link CreateCompanyUserResponse } + * @param userId {@link String } The unique identifier of the user. (required) + * @param updateCompanyUserRequest {@link UpdateCompanyUserRequest } (required) + * @return {@link CompanyUser } * @throws ApiException if fails to make API call */ - public CreateCompanyUserResponse createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest) throws ApiException, IOException { - return createNewUser(companyId, createCompanyUserRequest, null); + public CompanyUser updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest) throws ApiException, IOException { + return updateUserDetails(companyId, userId, updateCompanyUserRequest, null); } /** - * Create a new user + * Update user details * * @param companyId {@link String } The unique identifier of the company account. (required) - * @param createCompanyUserRequest {@link CreateCompanyUserRequest } (required) + * @param userId {@link String } The unique identifier of the user. (required) + * @param updateCompanyUserRequest {@link UpdateCompanyUserRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CreateCompanyUserResponse } + * @return {@link CompanyUser } * @throws ApiException if fails to make API call */ - public CreateCompanyUserResponse createNewUser(String companyId, CreateCompanyUserRequest createCompanyUserRequest, RequestOptions requestOptions) throws ApiException, IOException { + public CompanyUser updateUserDetails(String companyId, String userId, UpdateCompanyUserRequest updateCompanyUserRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); + if (userId == null) { + throw new IllegalArgumentException("Please provide the userId path parameter"); + } + pathParams.put("userId", userId); - String requestBody = createCompanyUserRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/users", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return CreateCompanyUserResponse.fromJson(jsonResult); + String requestBody = updateCompanyUserRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/users/{userId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return CompanyUser.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/UsersMerchantLevelApi.java b/src/main/java/com/adyen/service/management/UsersMerchantLevelApi.java index e2741eb50..6dbdd80fe 100644 --- a/src/main/java/com/adyen/service/management/UsersMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/UsersMerchantLevelApi.java @@ -55,50 +55,38 @@ public UsersMerchantLevelApi(Client client, String baseURL) { } /** - * Get a list of users + * Create a new user * * @param merchantId {@link String } Unique identifier of the merchant. (required) - * @return {@link ListMerchantUsersResponse } + * @param createMerchantUserRequest {@link CreateMerchantUserRequest } (required) + * @return {@link CreateUserResponse } * @throws ApiException if fails to make API call */ - public ListMerchantUsersResponse listUsers(String merchantId) throws ApiException, IOException { - return listUsers(merchantId, null, null, null, null); + public CreateUserResponse createNewUser(String merchantId, CreateMerchantUserRequest createMerchantUserRequest) throws ApiException, IOException { + return createNewUser(merchantId, createMerchantUserRequest, null); } /** - * Get a list of users + * Create a new user * * @param merchantId {@link String } Unique identifier of the merchant. (required) - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page. (optional) - * @param username {@link String } Query: The partial or complete username to select all users that match. (optional) + * @param createMerchantUserRequest {@link CreateMerchantUserRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListMerchantUsersResponse } + * @return {@link CreateUserResponse } * @throws ApiException if fails to make API call */ - public ListMerchantUsersResponse listUsers(String merchantId, Integer pageNumber, Integer pageSize, String username, RequestOptions requestOptions) throws ApiException, IOException { + public CreateUserResponse createNewUser(String merchantId, CreateMerchantUserRequest createMerchantUserRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); - } - if (username != null) { - queryParams.put("username", username); - } - String requestBody = null; + String requestBody = createMerchantUserRequest.toJson(); Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/users", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListMerchantUsersResponse.fromJson(jsonResult); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return CreateUserResponse.fromJson(jsonResult); } /** @@ -141,78 +129,90 @@ public User getUserDetails(String merchantId, String userId, RequestOptions requ } /** - * Update a user + * Get a list of users * * @param merchantId {@link String } Unique identifier of the merchant. (required) - * @param userId {@link String } Unique identifier of the user. (required) - * @param updateMerchantUserRequest {@link UpdateMerchantUserRequest } (required) - * @return {@link User } + * @return {@link ListMerchantUsersResponse } * @throws ApiException if fails to make API call */ - public User updateUser(String merchantId, String userId, UpdateMerchantUserRequest updateMerchantUserRequest) throws ApiException, IOException { - return updateUser(merchantId, userId, updateMerchantUserRequest, null); + public ListMerchantUsersResponse listUsers(String merchantId) throws ApiException, IOException { + return listUsers(merchantId, null, null, null, null); } /** - * Update a user + * Get a list of users * * @param merchantId {@link String } Unique identifier of the merchant. (required) - * @param userId {@link String } Unique identifier of the user. (required) - * @param updateMerchantUserRequest {@link UpdateMerchantUserRequest } (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page. (optional) + * @param username {@link String } Query: The partial or complete username to select all users that match. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link User } + * @return {@link ListMerchantUsersResponse } * @throws ApiException if fails to make API call */ - public User updateUser(String merchantId, String userId, UpdateMerchantUserRequest updateMerchantUserRequest, RequestOptions requestOptions) throws ApiException, IOException { + public ListMerchantUsersResponse listUsers(String merchantId, Integer pageNumber, Integer pageSize, String username, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (userId == null) { - throw new IllegalArgumentException("Please provide the userId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); + } + if (username != null) { + queryParams.put("username", username); } - pathParams.put("userId", userId); - String requestBody = updateMerchantUserRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/users/{userId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return User.fromJson(jsonResult); + String requestBody = null; + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/users", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListMerchantUsersResponse.fromJson(jsonResult); } /** - * Create a new user + * Update a user * * @param merchantId {@link String } Unique identifier of the merchant. (required) - * @param createMerchantUserRequest {@link CreateMerchantUserRequest } (required) - * @return {@link CreateUserResponse } + * @param userId {@link String } Unique identifier of the user. (required) + * @param updateMerchantUserRequest {@link UpdateMerchantUserRequest } (required) + * @return {@link User } * @throws ApiException if fails to make API call */ - public CreateUserResponse createNewUser(String merchantId, CreateMerchantUserRequest createMerchantUserRequest) throws ApiException, IOException { - return createNewUser(merchantId, createMerchantUserRequest, null); + public User updateUser(String merchantId, String userId, UpdateMerchantUserRequest updateMerchantUserRequest) throws ApiException, IOException { + return updateUser(merchantId, userId, updateMerchantUserRequest, null); } /** - * Create a new user + * Update a user * * @param merchantId {@link String } Unique identifier of the merchant. (required) - * @param createMerchantUserRequest {@link CreateMerchantUserRequest } (required) + * @param userId {@link String } Unique identifier of the user. (required) + * @param updateMerchantUserRequest {@link UpdateMerchantUserRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link CreateUserResponse } + * @return {@link User } * @throws ApiException if fails to make API call */ - public CreateUserResponse createNewUser(String merchantId, CreateMerchantUserRequest createMerchantUserRequest, RequestOptions requestOptions) throws ApiException, IOException { + public User updateUser(String merchantId, String userId, UpdateMerchantUserRequest updateMerchantUserRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); + if (userId == null) { + throw new IllegalArgumentException("Please provide the userId path parameter"); + } + pathParams.put("userId", userId); - String requestBody = createMerchantUserRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/users", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return CreateUserResponse.fromJson(jsonResult); + String requestBody = updateMerchantUserRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/users/{userId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return User.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/WebhooksCompanyLevelApi.java b/src/main/java/com/adyen/service/management/WebhooksCompanyLevelApi.java index 82c0b36fe..436d2fd0b 100644 --- a/src/main/java/com/adyen/service/management/WebhooksCompanyLevelApi.java +++ b/src/main/java/com/adyen/service/management/WebhooksCompanyLevelApi.java @@ -57,25 +57,27 @@ public WebhooksCompanyLevelApi(Client client, String baseURL) { } /** - * Remove a webhook + * Generate an HMAC key * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @return {@link GenerateHmacKeyResponse } * @throws ApiException if fails to make API call */ - public void removeWebhook(String companyId, String webhookId) throws ApiException, IOException { - removeWebhook(companyId, webhookId, null); + public GenerateHmacKeyResponse generateHmacKey(String companyId, String webhookId) throws ApiException, IOException { + return generateHmacKey(companyId, webhookId, null); } /** - * Remove a webhook + * Generate an HMAC key * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link GenerateHmacKeyResponse } * @throws ApiException if fails to make API call */ - public void removeWebhook(String companyId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { + public GenerateHmacKeyResponse generateHmacKey(String companyId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -88,116 +90,113 @@ public void removeWebhook(String companyId, String webhookId, RequestOptions req pathParams.put("webhookId", webhookId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}/generateHmac", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return GenerateHmacKeyResponse.fromJson(jsonResult); } /** - * List all webhooks + * Get a webhook * * @param companyId {@link String } Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required) - * @return {@link ListWebhooksResponse } + * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public ListWebhooksResponse listAllWebhooks(String companyId) throws ApiException, IOException { - return listAllWebhooks(companyId, null, null, null); + public Webhook getWebhook(String companyId, String webhookId) throws ApiException, IOException { + return getWebhook(companyId, webhookId, null); } /** - * List all webhooks + * Get a webhook * * @param companyId {@link String } Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required) - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) + * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListWebhooksResponse } + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public ListWebhooksResponse listAllWebhooks(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { + public Webhook getWebhook(String companyId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); + if (webhookId == null) { + throw new IllegalArgumentException("Please provide the webhookId path parameter"); } + pathParams.put("webhookId", webhookId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListWebhooksResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return Webhook.fromJson(jsonResult); } /** - * Get a webhook + * List all webhooks * * @param companyId {@link String } Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required) - * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @return {@link Webhook } + * @return {@link ListWebhooksResponse } * @throws ApiException if fails to make API call */ - public Webhook getWebhook(String companyId, String webhookId) throws ApiException, IOException { - return getWebhook(companyId, webhookId, null); + public ListWebhooksResponse listAllWebhooks(String companyId) throws ApiException, IOException { + return listAllWebhooks(companyId, null, null, null); } /** - * Get a webhook + * List all webhooks * * @param companyId {@link String } Unique identifier of the [company account](https://docs.adyen.com/account/account-structure#company-account). (required) - * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Webhook } + * @return {@link ListWebhooksResponse } * @throws ApiException if fails to make API call */ - public Webhook getWebhook(String companyId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { + public ListWebhooksResponse listAllWebhooks(String companyId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { throw new IllegalArgumentException("Please provide the companyId path parameter"); } pathParams.put("companyId", companyId); - if (webhookId == null) { - throw new IllegalArgumentException("Please provide the webhookId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); } - pathParams.put("webhookId", webhookId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return Webhook.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListWebhooksResponse.fromJson(jsonResult); } /** - * Update a webhook + * Remove a webhook * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param updateCompanyWebhookRequest {@link UpdateCompanyWebhookRequest } (required) - * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public Webhook updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest) throws ApiException, IOException { - return updateWebhook(companyId, webhookId, updateCompanyWebhookRequest, null); + public void removeWebhook(String companyId, String webhookId) throws ApiException, IOException { + removeWebhook(companyId, webhookId, null); } /** - * Update a webhook + * Remove a webhook * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param updateCompanyWebhookRequest {@link UpdateCompanyWebhookRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public Webhook updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { + public void removeWebhook(String companyId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -209,10 +208,9 @@ public Webhook updateWebhook(String companyId, String webhookId, UpdateCompanyWe } pathParams.put("webhookId", webhookId); - String requestBody = updateCompanyWebhookRequest.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return Webhook.fromJson(jsonResult); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); } /** @@ -251,27 +249,29 @@ public Webhook setUpWebhook(String companyId, CreateCompanyWebhookRequest create } /** - * Generate an HMAC key + * Test a webhook * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @return {@link GenerateHmacKeyResponse } + * @param testCompanyWebhookRequest {@link TestCompanyWebhookRequest } (required) + * @return {@link TestWebhookResponse } * @throws ApiException if fails to make API call */ - public GenerateHmacKeyResponse generateHmacKey(String companyId, String webhookId) throws ApiException, IOException { - return generateHmacKey(companyId, webhookId, null); + public TestWebhookResponse testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest) throws ApiException, IOException { + return testWebhook(companyId, webhookId, testCompanyWebhookRequest, null); } /** - * Generate an HMAC key + * Test a webhook * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param testCompanyWebhookRequest {@link TestCompanyWebhookRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GenerateHmacKeyResponse } + * @return {@link TestWebhookResponse } * @throws ApiException if fails to make API call */ - public GenerateHmacKeyResponse generateHmacKey(String companyId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { + public TestWebhookResponse testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -283,36 +283,36 @@ public GenerateHmacKeyResponse generateHmacKey(String companyId, String webhookI } pathParams.put("webhookId", webhookId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}/generateHmac", null); + String requestBody = testCompanyWebhookRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}/test", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return GenerateHmacKeyResponse.fromJson(jsonResult); + return TestWebhookResponse.fromJson(jsonResult); } /** - * Test a webhook + * Update a webhook * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param testCompanyWebhookRequest {@link TestCompanyWebhookRequest } (required) - * @return {@link TestWebhookResponse } + * @param updateCompanyWebhookRequest {@link UpdateCompanyWebhookRequest } (required) + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public TestWebhookResponse testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest) throws ApiException, IOException { - return testWebhook(companyId, webhookId, testCompanyWebhookRequest, null); + public Webhook updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest) throws ApiException, IOException { + return updateWebhook(companyId, webhookId, updateCompanyWebhookRequest, null); } /** - * Test a webhook + * Update a webhook * * @param companyId {@link String } The unique identifier of the company account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param testCompanyWebhookRequest {@link TestCompanyWebhookRequest } (required) + * @param updateCompanyWebhookRequest {@link UpdateCompanyWebhookRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TestWebhookResponse } + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public TestWebhookResponse testWebhook(String companyId, String webhookId, TestCompanyWebhookRequest testCompanyWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { + public Webhook updateWebhook(String companyId, String webhookId, UpdateCompanyWebhookRequest updateCompanyWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (companyId == null) { @@ -324,9 +324,9 @@ public TestWebhookResponse testWebhook(String companyId, String webhookId, TestC } pathParams.put("webhookId", webhookId); - String requestBody = testCompanyWebhookRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}/test", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return TestWebhookResponse.fromJson(jsonResult); + String requestBody = updateCompanyWebhookRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/companies/{companyId}/webhooks/{webhookId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return Webhook.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/management/WebhooksMerchantLevelApi.java b/src/main/java/com/adyen/service/management/WebhooksMerchantLevelApi.java index faefbb53b..3ded5b3d6 100644 --- a/src/main/java/com/adyen/service/management/WebhooksMerchantLevelApi.java +++ b/src/main/java/com/adyen/service/management/WebhooksMerchantLevelApi.java @@ -57,25 +57,27 @@ public WebhooksMerchantLevelApi(Client client, String baseURL) { } /** - * Remove a webhook + * Generate an HMAC key * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param webhookId {@link String } (required) + * @return {@link GenerateHmacKeyResponse } * @throws ApiException if fails to make API call */ - public void removeWebhook(String merchantId, String webhookId) throws ApiException, IOException { - removeWebhook(merchantId, webhookId, null); + public GenerateHmacKeyResponse generateHmacKey(String merchantId, String webhookId) throws ApiException, IOException { + return generateHmacKey(merchantId, webhookId, null); } /** - * Remove a webhook + * Generate an HMAC key * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param webhookId {@link String } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) + * @return {@link GenerateHmacKeyResponse } * @throws ApiException if fails to make API call */ - public void removeWebhook(String merchantId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { + public GenerateHmacKeyResponse generateHmacKey(String merchantId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -88,116 +90,113 @@ public void removeWebhook(String merchantId, String webhookId, RequestOptions re pathParams.put("webhookId", webhookId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}", null); - resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}/generateHmac", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return GenerateHmacKeyResponse.fromJson(jsonResult); } /** - * List all webhooks + * Get a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @return {@link ListWebhooksResponse } + * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public ListWebhooksResponse listAllWebhooks(String merchantId) throws ApiException, IOException { - return listAllWebhooks(merchantId, null, null, null); + public Webhook getWebhook(String merchantId, String webhookId) throws ApiException, IOException { + return getWebhook(merchantId, webhookId, null); } /** - * List all webhooks + * Get a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) - * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) + * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ListWebhooksResponse } + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public ListWebhooksResponse listAllWebhooks(String merchantId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { + public Webhook getWebhook(String merchantId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - //Add query params - Map queryParams = new HashMap<>(); - if (pageNumber != null) { - queryParams.put("pageNumber", pageNumber.toString()); - } - if (pageSize != null) { - queryParams.put("pageSize", pageSize.toString()); + if (webhookId == null) { + throw new IllegalArgumentException("Please provide the webhookId path parameter"); } + pathParams.put("webhookId", webhookId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); - return ListWebhooksResponse.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); + return Webhook.fromJson(jsonResult); } /** - * Get a webhook + * List all webhooks * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @return {@link Webhook } + * @return {@link ListWebhooksResponse } * @throws ApiException if fails to make API call */ - public Webhook getWebhook(String merchantId, String webhookId) throws ApiException, IOException { - return getWebhook(merchantId, webhookId, null); + public ListWebhooksResponse listAllWebhooks(String merchantId) throws ApiException, IOException { + return listAllWebhooks(merchantId, null, null, null); } /** - * Get a webhook + * List all webhooks * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param pageNumber {@link Integer } Query: The number of the page to fetch. (optional) + * @param pageSize {@link Integer } Query: The number of items to have on a page, maximum 100. The default is 10 items on a page. (optional) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Webhook } + * @return {@link ListWebhooksResponse } * @throws ApiException if fails to make API call */ - public Webhook getWebhook(String merchantId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { + public ListWebhooksResponse listAllWebhooks(String merchantId, Integer pageNumber, Integer pageSize, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { throw new IllegalArgumentException("Please provide the merchantId path parameter"); } pathParams.put("merchantId", merchantId); - if (webhookId == null) { - throw new IllegalArgumentException("Please provide the webhookId path parameter"); + //Add query params + Map queryParams = new HashMap<>(); + if (pageNumber != null) { + queryParams.put("pageNumber", pageNumber.toString()); + } + if (pageSize != null) { + queryParams.put("pageSize", pageSize.toString()); } - pathParams.put("webhookId", webhookId); String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams); - return Webhook.fromJson(jsonResult); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.GET, pathParams, queryParams); + return ListWebhooksResponse.fromJson(jsonResult); } /** - * Update a webhook + * Remove a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param updateMerchantWebhookRequest {@link UpdateMerchantWebhookRequest } (required) - * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public Webhook updateWebhook(String merchantId, String webhookId, UpdateMerchantWebhookRequest updateMerchantWebhookRequest) throws ApiException, IOException { - return updateWebhook(merchantId, webhookId, updateMerchantWebhookRequest, null); + public void removeWebhook(String merchantId, String webhookId) throws ApiException, IOException { + removeWebhook(merchantId, webhookId, null); } /** - * Update a webhook + * Remove a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param updateMerchantWebhookRequest {@link UpdateMerchantWebhookRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public Webhook updateWebhook(String merchantId, String webhookId, UpdateMerchantWebhookRequest updateMerchantWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { + public void removeWebhook(String merchantId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -209,10 +208,9 @@ public Webhook updateWebhook(String merchantId, String webhookId, UpdateMerchant } pathParams.put("webhookId", webhookId); - String requestBody = updateMerchantWebhookRequest.toJson(); + String requestBody = null; Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); - return Webhook.fromJson(jsonResult); + resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.DELETE, pathParams); } /** @@ -251,27 +249,29 @@ public Webhook setUpWebhook(String merchantId, CreateMerchantWebhookRequest crea } /** - * Generate an HMAC key + * Test a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param webhookId {@link String } (required) - * @return {@link GenerateHmacKeyResponse } + * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param testWebhookRequest {@link TestWebhookRequest } (required) + * @return {@link TestWebhookResponse } * @throws ApiException if fails to make API call */ - public GenerateHmacKeyResponse generateHmacKey(String merchantId, String webhookId) throws ApiException, IOException { - return generateHmacKey(merchantId, webhookId, null); + public TestWebhookResponse testWebhook(String merchantId, String webhookId, TestWebhookRequest testWebhookRequest) throws ApiException, IOException { + return testWebhook(merchantId, webhookId, testWebhookRequest, null); } /** - * Generate an HMAC key + * Test a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) - * @param webhookId {@link String } (required) + * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) + * @param testWebhookRequest {@link TestWebhookRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link GenerateHmacKeyResponse } + * @return {@link TestWebhookResponse } * @throws ApiException if fails to make API call */ - public GenerateHmacKeyResponse generateHmacKey(String merchantId, String webhookId, RequestOptions requestOptions) throws ApiException, IOException { + public TestWebhookResponse testWebhook(String merchantId, String webhookId, TestWebhookRequest testWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -283,36 +283,36 @@ public GenerateHmacKeyResponse generateHmacKey(String merchantId, String webhook } pathParams.put("webhookId", webhookId); - String requestBody = null; - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}/generateHmac", null); + String requestBody = testWebhookRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}/test", null); String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return GenerateHmacKeyResponse.fromJson(jsonResult); + return TestWebhookResponse.fromJson(jsonResult); } /** - * Test a webhook + * Update a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param testWebhookRequest {@link TestWebhookRequest } (required) - * @return {@link TestWebhookResponse } + * @param updateMerchantWebhookRequest {@link UpdateMerchantWebhookRequest } (required) + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public TestWebhookResponse testWebhook(String merchantId, String webhookId, TestWebhookRequest testWebhookRequest) throws ApiException, IOException { - return testWebhook(merchantId, webhookId, testWebhookRequest, null); + public Webhook updateWebhook(String merchantId, String webhookId, UpdateMerchantWebhookRequest updateMerchantWebhookRequest) throws ApiException, IOException { + return updateWebhook(merchantId, webhookId, updateMerchantWebhookRequest, null); } /** - * Test a webhook + * Update a webhook * * @param merchantId {@link String } The unique identifier of the merchant account. (required) * @param webhookId {@link String } Unique identifier of the webhook configuration. (required) - * @param testWebhookRequest {@link TestWebhookRequest } (required) + * @param updateMerchantWebhookRequest {@link UpdateMerchantWebhookRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link TestWebhookResponse } + * @return {@link Webhook } * @throws ApiException if fails to make API call */ - public TestWebhookResponse testWebhook(String merchantId, String webhookId, TestWebhookRequest testWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { + public Webhook updateWebhook(String merchantId, String webhookId, UpdateMerchantWebhookRequest updateMerchantWebhookRequest, RequestOptions requestOptions) throws ApiException, IOException { //Add path params Map pathParams = new HashMap<>(); if (merchantId == null) { @@ -324,9 +324,9 @@ public TestWebhookResponse testWebhook(String merchantId, String webhookId, Test } pathParams.put("webhookId", webhookId); - String requestBody = testWebhookRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}/test", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return TestWebhookResponse.fromJson(jsonResult); + String requestBody = updateMerchantWebhookRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/merchants/{merchantId}/webhooks/{webhookId}", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.PATCH, pathParams); + return Webhook.fromJson(jsonResult); } } diff --git a/src/main/java/com/adyen/service/transfers/TransactionsApi.java b/src/main/java/com/adyen/service/transfers/TransactionsApi.java index c3eae2cee..12a4fb5dc 100644 --- a/src/main/java/com/adyen/service/transfers/TransactionsApi.java +++ b/src/main/java/com/adyen/service/transfers/TransactionsApi.java @@ -116,7 +116,7 @@ public TransactionSearchResponse getAllTransactions(String balancePlatform, Stri /** * Get a transaction * - * @param id {@link String } Unique identifier of the transaction. (required) + * @param id {@link String } The unique identifier of the transaction. (required) * @return {@link Transaction } * @throws ApiException if fails to make API call */ @@ -127,7 +127,7 @@ public Transaction getTransaction(String id) throws ApiException, IOException { /** * Get a transaction * - * @param id {@link String } Unique identifier of the transaction. (required) + * @param id {@link String } The unique identifier of the transaction. (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) * @return {@link Transaction } * @throws ApiException if fails to make API call diff --git a/src/main/java/com/adyen/service/transfers/TransfersApi.java b/src/main/java/com/adyen/service/transfers/TransfersApi.java index 22a91a8ad..1c41af76f 100644 --- a/src/main/java/com/adyen/service/transfers/TransfersApi.java +++ b/src/main/java/com/adyen/service/transfers/TransfersApi.java @@ -55,64 +55,64 @@ public TransfersApi(Client client, String baseURL) { } /** - * Transfer funds + * Return a transfer * - * @param transferInfo {@link TransferInfo } (required) - * @return {@link Transfer } + * @param transferId {@link String } The unique identifier of the transfer to be returned. (required) + * @param returnTransferRequest {@link ReturnTransferRequest } (required) + * @return {@link ReturnTransferResponse } * @throws ApiException if fails to make API call */ - public Transfer transferFunds(TransferInfo transferInfo) throws ApiException, IOException { - return transferFunds(transferInfo, null); + public ReturnTransferResponse returnTransfer(String transferId, ReturnTransferRequest returnTransferRequest) throws ApiException, IOException { + return returnTransfer(transferId, returnTransferRequest, null); } /** - * Transfer funds + * Return a transfer * - * @param transferInfo {@link TransferInfo } (required) + * @param transferId {@link String } The unique identifier of the transfer to be returned. (required) + * @param returnTransferRequest {@link ReturnTransferRequest } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link Transfer } + * @return {@link ReturnTransferResponse } * @throws ApiException if fails to make API call */ - public Transfer transferFunds(TransferInfo transferInfo, RequestOptions requestOptions) throws ApiException, IOException { + public ReturnTransferResponse returnTransfer(String transferId, ReturnTransferRequest returnTransferRequest, RequestOptions requestOptions) throws ApiException, IOException { + //Add path params + Map pathParams = new HashMap<>(); + if (transferId == null) { + throw new IllegalArgumentException("Please provide the transferId path parameter"); + } + pathParams.put("transferId", transferId); - String requestBody = transferInfo.toJson(); - Resource resource = new Resource(this, this.baseURL + "/transfers", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); - return Transfer.fromJson(jsonResult); + String requestBody = returnTransferRequest.toJson(); + Resource resource = new Resource(this, this.baseURL + "/transfers/{transferId}/returns", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); + return ReturnTransferResponse.fromJson(jsonResult); } /** - * Return a transfer + * Transfer funds * - * @param id {@link String } The unique identifier of the transfer to be returned. (required) - * @param returnTransferRequest {@link ReturnTransferRequest } (required) - * @return {@link ReturnTransferResponse } + * @param transferInfo {@link TransferInfo } (required) + * @return {@link Transfer } * @throws ApiException if fails to make API call */ - public ReturnTransferResponse returnTransfer(String id, ReturnTransferRequest returnTransferRequest) throws ApiException, IOException { - return returnTransfer(id, returnTransferRequest, null); + public Transfer transferFunds(TransferInfo transferInfo) throws ApiException, IOException { + return transferFunds(transferInfo, null); } /** - * Return a transfer + * Transfer funds * - * @param id {@link String } The unique identifier of the transfer to be returned. (required) - * @param returnTransferRequest {@link ReturnTransferRequest } (required) + * @param transferInfo {@link TransferInfo } (required) * @param requestOptions {@link RequestOptions } Object to store additional data such as idempotency-keys (optional) - * @return {@link ReturnTransferResponse } + * @return {@link Transfer } * @throws ApiException if fails to make API call */ - public ReturnTransferResponse returnTransfer(String id, ReturnTransferRequest returnTransferRequest, RequestOptions requestOptions) throws ApiException, IOException { - //Add path params - Map pathParams = new HashMap<>(); - if (id == null) { - throw new IllegalArgumentException("Please provide the id path parameter"); - } - pathParams.put("id", id); + public Transfer transferFunds(TransferInfo transferInfo, RequestOptions requestOptions) throws ApiException, IOException { - String requestBody = returnTransferRequest.toJson(); - Resource resource = new Resource(this, this.baseURL + "/transfers/{id}/returns", null); - String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, pathParams); - return ReturnTransferResponse.fromJson(jsonResult); + String requestBody = transferInfo.toJson(); + Resource resource = new Resource(this, this.baseURL + "/transfers", null); + String jsonResult = resource.request(requestBody, requestOptions, ApiConstants.HttpMethod.POST, null); + return Transfer.fromJson(jsonResult); } }