Deprecated API

Contents

• Deprecated Methods
• Deprecated Constructors

Deprecated Methods

Method and Description
com.paypal.api.payments.Order.authorize(String) Please use Order.authorize(APIContext) instead.
com.paypal.api.payments.EventType.availableEventTypes(String) Please use EventType.availableEventTypes(APIContext) instead.
com.paypal.api.payments.Agreement.billBalance(String, AgreementStateDescriptor) Please use Agreement.billBalance(APIContext, AgreementStateDescriptor) instead.
com.paypal.api.payments.Agreement.cancel(String, AgreementStateDescriptor) Please use Agreement.cancel(APIContext, AgreementStateDescriptor) instead.
com.paypal.api.payments.Invoice.cancel(String, CancelNotification) Please use Invoice.cancel(APIContext, CancelNotification) instead.
com.paypal.api.payments.PayoutItem.cancel(String, String) Please use PayoutItem.cancel(APIContext, String) instead.
com.paypal.api.payments.Authorization.capture(String, Capture) Please use Authorization.capture(APIContext, Capture) instead.
com.paypal.api.payments.Order.capture(String, Capture) Please use Order.capture(APIContext, Capture) instead.
com.paypal.base.rest.PayPalResource.configureAndExecute(APIContext, HttpMethod, String, Map<String, String>, String, Class<T>) Please use PayPalResource.configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Headers could be passed directly to #APIContext itself.
com.paypal.base.rest.PayPalResource.configureAndExecute(String, HttpMethod, String, String, Class<T>) Please use PayPalResource.configureAndExecute(APIContext, HttpMethod, String, String, Class) instead. Passing APIContext gives us better information than just raw access token.
com.paypal.api.payments.Agreement.create(String) Please use Agreement.create(APIContext) instead.
com.paypal.api.payments.CreditCard.create(String) Please use CreditCard.create(APIContext) instead.
com.paypal.api.payments.Invoice.create(String) Please use Invoice.create(APIContext) instead.
com.paypal.api.payments.Payment.create(String) Please use Payment.create(APIContext) instead.
com.paypal.api.payments.Plan.create(String) Please use Plan.create(APIContext) instead.
com.paypal.api.payments.WebProfile.create(String) Please use WebProfile.create(APIContext) instead.
com.paypal.api.payments.Payout.create(String, Map<String, String>) Please use Payout.create(APIContext, Map) instead.
com.paypal.api.payments.Webhook.create(String, Webhook) Please use Webhook.create(APIContext, Webhook) instead.
com.paypal.api.openidconnect.Tokeninfo.createFromAuthorizationCode(APIContext, CreateFromAuthorizationCodeParameters) Please use Tokeninfo.createFromAuthorizationCode(APIContext, String) instead. There is no more need for passing clientId and secret in the params object anymore.
com.paypal.api.openidconnect.Tokeninfo.createFromAuthorizationCode(CreateFromAuthorizationCodeParameters) Please use Tokeninfo.createFromAuthorizationCode(APIContext, String) instead. There is no more need for passing clientId and secret in the params object anymore.
com.paypal.api.payments.Payout.createSynchronous(String) Please use Payout.createSynchronous(APIContext) instead.
com.paypal.api.payments.CreditCard.delete(String) Please use CreditCard.delete(APIContext) instead.
com.paypal.api.payments.Invoice.delete(String) Please use Invoice.delete(APIContext) instead.
com.paypal.api.payments.WebProfile.delete(String) Please use WebProfile.delete(APIContext) instead.
com.paypal.api.payments.Webhook.delete(String, String) Please use Webhook.delete(APIContext, String) instead.
com.paypal.api.payments.Authorization.doVoid(String) Please use Authorization.doVoid(APIContext) instead.
com.paypal.api.payments.Order.doVoid(String) Please use Order.doVoid(APIContext) instead.
com.paypal.base.SSLUtil.downloadCertificateFromPath(String) Please use SSLUtil.downloadCertificateFromPath(String, Map) instead.
com.paypal.api.payments.Agreement.execute(String) Please use Agreement.execute(APIContext, String) instead.
com.paypal.api.payments.Payment.execute(String, PaymentExecution) Please use Payment.execute(APIContext, PaymentExecution) instead.
com.paypal.api.payments.Templates.get(APIContext, String) Please use Template.get(APIContext, String) instead.
com.paypal.api.payments.Agreement.get(String, String) Please use Agreement.get(APIContext, String) instead.
com.paypal.api.payments.Authorization.get(String, String) Please use Authorization.get(APIContext, String) instead.
com.paypal.api.payments.Capture.get(String, String) Please use Capture.get(APIContext, String) instead.
com.paypal.api.payments.CreditCard.get(String, String) Please use CreditCard.get(APIContext, String) instead.
com.paypal.api.payments.Event.get(String, String) Please use Event.get(APIContext, String) instead.
com.paypal.api.payments.Invoice.get(String, String) Please use Invoice.get(APIContext, String) instead.
com.paypal.api.payments.Order.get(String, String) Please use Order.get(APIContext, String) instead.
com.paypal.api.payments.Payment.get(String, String) Please use Payment.get(APIContext, String) instead.
com.paypal.api.payments.Payout.get(String, String) Please use Payout.get(APIContext, String) instead.
com.paypal.api.payments.PayoutItem.get(String, String) Please use PayoutItem.get(APIContext, String) instead.
com.paypal.api.payments.Plan.get(String, String) Please use Plan.get(APIContext, String) instead.
com.paypal.api.payments.Refund.get(String, String) Please use Refund.get(APIContext, String) instead.
com.paypal.api.payments.Sale.get(String, String) Please use Sale.get(APIContext, String) instead.
com.paypal.api.payments.Webhook.get(String, String) Please use Webhook.get(APIContext, String) instead.
com.paypal.api.payments.WebProfile.get(String, String) Please use WebProfile.get(APIContext, String) instead.
com.paypal.api.payments.PaymentCard.get3dSecureInfo() Please use PaymentCard.getCard3dSecureInfo() instead. Getter for 3dSecureInfo
com.paypal.base.rest.APIContext.getAccessToken() Please use APIContext.fetchAccessToken() instead. Previously, this was a dumb getter method. However, we enabled the feature to re-generate the access Token if null, or expired. This required us to throw proper PayPalRESTException, with error information on failure.
com.paypal.api.payments.PayerInfo.getAccountNumber() use PayerInfo.buyerAccountNumber instead
com.paypal.api.payments.Invoice.getAll(String) Please use Invoice.getAll(APIContext) instead.
com.paypal.api.payments.WebhookList.getAll(String) Please use WebhookList.getAll(APIContext) instead.
com.paypal.api.openidconnect.Userinfo.getBirthdate() PayPal API returns 'birthday', use that instead
com.paypal.base.rest.PayPalResource.getClientCredential() Please use static method `getCredential` instead. Returns ClientCredentials with client id and client secret from configuration Map.
com.paypal.api.payments.Error.getCode() This property is not available publicly PayPal internal error code.
com.paypal.api.payments.ErrorDetails.getCode() This property is not publicly available PayPal internal error code.
com.paypal.base.HttpConfiguration.getContentType() Set/Get Content-Type HTTP Header in APIContext HTTPHeaders parameter
com.paypal.api.payments.CreditCard.getCvv2() Please use CreditCard.getCvv2String() instead. Getter for cvv2 Returns -1 if cvv2 is null. Not autogenerating using lombok as it includes logic to return -1 on null.
com.paypal.api.payments.Error.getFmfDetails() This property is not available publicly Fraud filter details. Only supported when the `payment_method` is set to `credit_card`
com.paypal.api.payments.Payer.getFundingOption()
com.paypal.base.rest.APIContext.getHeadersMap() Use getHTTPHeaders() instead
com.paypal.api.payments.WebProfile.getList(String) Please use WebProfile.getList(APIContext) instead.
com.paypal.base.ConfigManager.getNumOfAcct() This code is not used anymore. This was used for older sdk_config.properties parsing.
com.paypal.api.payments.Invoice.getPaymentDetails() Please use Invoice.getPayments() instead.
com.paypal.api.payments.Order.getPendingReason() Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.
com.paypal.api.payments.Error.getProcessorResponse() This property is not available publicly response codes returned from a payment processor such as avs, cvv, etc. Only supported when the `payment_method` is set to `credit_card`.
com.paypal.api.payments.Error.getPurchaseUnitReferenceId() This property is not available publicly Reference ID of the purchase_unit associated with this error
com.paypal.api.payments.ErrorDetails.getPurchaseUnitReferenceId() This property is not publicly available Reference ID of the purchase_unit associated with this error
com.paypal.api.payments.Order.getReferenceId() Use Order.purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
com.paypal.api.payments.Invoice.getRefundDetails() Please use Invoice.getRefunds() instead.
com.paypal.api.payments.PayerInfo.getShippingAddress() Use shipping address present in purchase unit or at root level of checkout Session.
com.paypal.api.payments.AgreementTransaction.getTimeUpdated() use getTimeStamp instead. Getter for timeUpdated
com.paypal.api.payments.FuturePayment.getTokeninfo(CreateFromAuthorizationCodeParameters) Please use FuturePayment.fetchRefreshToken(APIContext, String) instead. In this method, we need to pass clientID, secret information that is already known to apiContext. The newer method allows for better code readability, and make it less error prone.
com.paypal.api.payments.FuturePayment.getTokeninfo(CreateFromRefreshTokenParameters, Tokeninfo) Please use FuturePayment.fetchRefreshToken(APIContext, String) instead. In this method, we need to pass clientID, secret information that is already known to apiContext. The newer method allows for better code readability, and make it less error prone.
com.paypal.api.openidconnect.Userinfo.getUserinfo(String) Please use Userinfo.getUserinfo(APIContext) instead.
com.paypal.base.ConfigManager.getValue(String) This code was used for older integrations. Not valid anymore. To be removed in the next major release.
com.paypal.base.ConfigManager.getValuesByCategory(String) This code was used for older integrations. Not valid anymore. To be removed in the next major release.
com.paypal.base.ConfigManager.getValueWithDefault(String, String) This code was used for older integrations. Not valid anymore. To be removed in the next major release.
com.paypal.base.codec.binary.Base64.isArrayByteBase64(byte[]) 1.5 Use Base64.isBase64(byte[]), will be removed in 2.0.
com.paypal.base.ConfigManager.isPropertyLoaded() This code was used for older integrations. Not valid anymore. To be removed in the next major release.
com.paypal.api.payments.CreditCard.list(String) Please use CreditCard.list(APIContext, Map) instead.
com.paypal.api.payments.CreditCard.list(String, Map<String, String>) Please use CreditCard.list(APIContext, Map) instead.
com.paypal.api.payments.Payment.list(String, Map<String, String>) Please use Payment.list(APIContext, Map) instead.
com.paypal.api.payments.Plan.list(String, Map<String, String>) Please use Plan.list(APIContext, Map) instead.
com.paypal.api.payments.Event.list(String, String) Please use Event.list(APIContext, String) instead.
com.paypal.base.ConfigManager.load(InputStream) This code was used for older integrations. Not valid anymore. To be removed in the next major release.
com.paypal.base.ConfigManager.load(Properties) This code was used for older integrations. Not valid anymore. To be removed in the next major release.
com.paypal.api.payments.WebProfile.partialUpdate(String, PatchRequest) Please use WebProfile.partialUpdate(APIContext, PatchRequest) instead.
com.paypal.api.payments.Invoice.qrCode(APIContext, String) Please use Invoice.qrCode(APIContext, String, Map) instead.
com.paypal.api.payments.Agreement.reActivate(String, AgreementStateDescriptor) Please use Agreement.reActivate(APIContext, AgreementStateDescriptor) instead.
com.paypal.api.payments.Authorization.reauthorize(String) Please use Authorization.reauthorize(APIContext) instead.
com.paypal.api.payments.Invoice.recordPayment(String, PaymentDetail) Please use Invoice.recordPayment(APIContext, PaymentDetail) instead.
com.paypal.api.payments.Invoice.recordRefund(String, RefundDetail) Please use Invoice.recordRefund(APIContext, RefundDetail) instead.
com.paypal.api.payments.Capture.refund(APIContext, Refund) Please use Capture.refund(APIContext, RefundRequest) instead Refunds a captured payment, by ID. Include an `amount` object in the JSON request body.
com.paypal.api.payments.Sale.refund(APIContext, Refund) Please use Sale.refund(APIContext, RefundRequest) instead Refunds a sale, by ID. For a full refund, include an empty payload in the JSON request body. For a partial refund, include an `amount` object in the JSON request body.
com.paypal.api.payments.Capture.refund(String, Refund) Please use Capture.refund(APIContext, Refund) instead.
com.paypal.api.payments.Sale.refund(String, Refund) Please use Sale.refund(APIContext, Refund) instead.
com.paypal.api.payments.Invoice.remind(String, Notification) Please use Invoice.remind(APIContext, Notification) instead.
com.paypal.api.payments.Event.resend(String) Please use Event.resend(APIContext) instead.
com.paypal.api.payments.Invoice.search(String, Search) Please use Invoice.search(APIContext, Search) instead.
com.paypal.api.payments.Invoice.send(String) Please use Invoice.send(APIContext) instead.
com.paypal.api.payments.PaymentCard.set3dSecureInfo(Card3dSecureInfo) Please use PaymentCard.setCard3dSecureInfo(Card3dSecureInfo) instead. Setter for 3dSecureInfo
com.paypal.api.payments.PayerInfo.setAccountNumber(String) use PayerInfo.buyerAccountNumber instead
com.paypal.api.payments.Agreement.setBalance(String, Currency) Please use Agreement.setBalance(APIContext, Currency) instead.
com.paypal.api.openidconnect.Userinfo.setBirthdate(String) PayPal API returns 'birthday', use that instead
com.paypal.api.payments.Error.setCode(String) This property is not available publicly PayPal internal error code.
com.paypal.api.payments.ErrorDetails.setCode(String) This property is not publicly available PayPal internal error code.
com.paypal.base.HttpConfiguration.setContentType(String) Set/Get Content-Type HTTP Header in APIContext HTTPHeaders parameter
com.paypal.api.payments.CreditCard.setCvv2(Integer) The cvv2 needs to be a string, as any cvv2 starting with 0 is sent invalid to servers. Please use CreditCard.setCvv2(String) instead.
com.paypal.api.payments.Error.setFmfDetails(FmfDetails) This property is not available publicly Fraud filter details. Only supported when the `payment_method` is set to `credit_card`
com.paypal.api.payments.Payer.setFundingOption(FundingOption)
com.paypal.base.rest.APIContext.setHeadersMap(Map<String, String>) Please use APIContext.setHTTPHeaders(Map) or APIContext.addHTTPHeaders(Map) instead.
com.paypal.api.payments.Invoice.setPaymentDetails(List<PaymentDetail>) Please use Invoice.setPayments(List) instead.
com.paypal.api.payments.Order.setPendingReason(String) Reason code for the transaction state being Pending. Obsolete. Retained for backward compatability. Use reason_code field above instead.
com.paypal.api.payments.Error.setProcessorResponse(ProcessorResponse) This property is not available publicly response codes returned from a payment processor such as avs, cvv, etc. Only supported when the `payment_method` is set to `credit_card`.
com.paypal.api.payments.Error.setPurchaseUnitReferenceId(String) This property is not available publicly Reference ID of the purchase_unit associated with this error
com.paypal.api.payments.ErrorDetails.setPurchaseUnitReferenceId(String) This property is not publicly available Reference ID of the purchase_unit associated with this error
com.paypal.api.payments.Order.setReferenceId(String) Use Order.purchaseUnitReferenceId instead Identifier to the purchase unit associated with this object. Obsolete. Use one in cart_base.
com.paypal.api.payments.Invoice.setRefundDetails(List<RefundDetail>) Please use Invoice.setRefunds(List) instead.
com.paypal.api.payments.PayerInfo.setShippingAddress(ShippingAddress) Use shipping address present in purchase unit or at root level of checkout Session.
com.paypal.api.payments.AgreementTransaction.setTimeUpdated(String) use setTimeStamp instead. Setter for timeUpdated
com.paypal.api.payments.EventType.subscribedEventTypes(String, String) Please use EventType.subscribedEventTypes(APIContext, String) instead.
com.paypal.api.payments.Agreement.suspend(String, AgreementStateDescriptor) Please use Agreement.suspend(APIContext, AgreementStateDescriptor) instead.
com.paypal.api.payments.Agreement.transactions(String, String, Date, Date) Please use Agreement.transactions(APIContext, String, Date, Date) instead.
com.paypal.api.payments.Invoice.update(String) Please use Invoice.update(APIContext) instead.
com.paypal.api.payments.WebProfile.update(String) Please use WebProfile.update(APIContext) instead.
com.paypal.api.payments.Agreement.update(String, List<Patch>) Please use Agreement.update(APIContext, List) instead.
com.paypal.api.payments.CreditCard.update(String, List<Patch>) Please use CreditCard.update(APIContext, List) instead.
com.paypal.api.payments.Payment.update(String, List<Patch>) Please use Payment.update(APIContext, List) instad.
com.paypal.api.payments.Plan.update(String, List<Patch>) Please use Plan.update(APIContext, List) instead.
com.paypal.api.payments.Webhook.update(String, String, String) Please use Webhook.update(APIContext, String, String) instead.

Deprecated Constructors

Constructor and Description
com.paypal.base.rest.APIContext() Please use APIContext.APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods: APIContext context = new APIContext(clientId, clientSecret, "sandbox");
com.paypal.base.rest.APIContext(String) Please use APIContext.APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods: APIContext context = new APIContext(clientId, clientSecret, "sandbox");
com.paypal.base.rest.APIContext(String, String) Please use APIContext.APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods: APIContext context = new APIContext(clientId, clientSecret, "sandbox");