| Package | Description |
|---|---|
| com.paypal.api.openidconnect | |
| com.paypal.api.payments | |
| com.paypal.base | |
| com.paypal.base.rest |
| Modifier and Type | Method and Description |
|---|---|
static Tokeninfo |
Tokeninfo.createFromAuthorizationCode(APIContext apiContext,
CreateFromAuthorizationCodeParameters createFromAuthorizationCodeParameters)
Creates an Access Token from an Authorization Code.
|
static Tokeninfo |
Tokeninfo.createFromAuthorizationCode(CreateFromAuthorizationCodeParameters createFromAuthorizationCodeParameters)
Creates an Access Token from an Authorization Code.
|
static Tokeninfo |
Tokeninfo.createFromAuthorizationCodeForFpp(APIContext apiContext,
CreateFromAuthorizationCodeParameters createFromAuthorizationCodeParameters)
Creates an Access and a Refresh Tokens from an Authorization Code for future payment.
|
Tokeninfo |
Tokeninfo.createFromRefreshToken(APIContext apiContext,
CreateFromRefreshTokenParameters createFromRefreshTokenParameters)
Creates an Access Token from an Refresh Token.
|
Tokeninfo |
Tokeninfo.createFromRefreshToken(CreateFromRefreshTokenParameters createFromRefreshTokenParameters)
Creates an Access Token from an Refresh Token.
|
Tokeninfo |
Tokeninfo.createFromRefreshTokenForFpp(APIContext apiContext)
Creates an Access Token from an Refresh Token for future payment.
|
static Userinfo |
Userinfo.getUserinfo(APIContext apiContext)
Returns user details
|
static Userinfo |
Userinfo.getUserinfo(String accessToken)
Returns user details
|
| Modifier and Type | Method and Description |
|---|---|
Authorization |
Order.authorize(APIContext apiContext)
Creates an authorization on an order
|
Authorization |
Order.authorize(String accessToken)
Creates an authorization on an order
|
static EventTypeList |
EventType.availableEventTypes(APIContext apiContext)
Retrieves the master list of available Webhooks events-types resources for any webhook to subscribe to.
|
static EventTypeList |
EventType.availableEventTypes(String accessToken)
Retrieves the master list of available Webhooks events-types resources for any webhook to subscribe to.
|
void |
Agreement.billBalance(APIContext apiContext,
AgreementStateDescriptor agreementStateDescriptor)
Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI.
|
void |
Agreement.billBalance(String accessToken,
AgreementStateDescriptor agreementStateDescriptor)
Bill an outstanding amount for an agreement by passing the ID of the agreement to the request URI.
|
void |
Agreement.cancel(APIContext apiContext,
AgreementStateDescriptor agreementStateDescriptor)
Cancel a billing agreement by passing the ID of the agreement to the request URI.
|
void |
Invoice.cancel(APIContext apiContext,
CancelNotification cancelNotification)
Cancels an invoice.
|
static PayoutItemDetails |
PayoutItem.cancel(APIContext apiContext,
String payoutItemId)
Cancels the unclaimed payment using the items id passed in the request
URI.
|
void |
Agreement.cancel(String accessToken,
AgreementStateDescriptor agreementStateDescriptor)
Cancel a billing agreement by passing the ID of the agreement to the request URI.
|
void |
Invoice.cancel(String accessToken,
CancelNotification cancelNotification)
Cancels an invoice.
|
static PayoutItemDetails |
PayoutItem.cancel(String accessToken,
String payoutItemId)
Cancels the unclaimed payment using the items id passed in the request
URI.
|
Capture |
Order.capture(APIContext apiContext,
Capture capture)
Creates (and processes) a new Capture Transaction added as a related resource.
|
Capture |
Authorization.capture(APIContext apiContext,
Capture capture)
Creates (and processes) a new Capture Transaction added as a related resource.
|
Capture |
Order.capture(String accessToken,
Capture capture)
Creates (and processes) a new Capture Transaction added as a related resource.
|
Capture |
Authorization.capture(String accessToken,
Capture capture)
Creates (and processes) a new Capture Transaction added as a related resource.
|
CreateProfileResponse |
WebProfile.create(APIContext apiContext)
Create a web experience profile by passing the name of the profile and other profile details in the request JSON to the request URI.
|
Plan |
Plan.create(APIContext apiContext)
Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI.
|
Payment |
Payment.create(APIContext apiContext)
Creates (and processes) a new Payment Resource.
|
Invoice |
Invoice.create(APIContext apiContext)
Creates a new invoice Resource.
|
CreditCard |
CreditCard.create(APIContext apiContext)
Creates a new Credit Card Resource (aka Tokenize).
|
Agreement |
Agreement.create(APIContext apiContext)
Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON.
|
PayoutBatch |
Payout.create(APIContext apiContext,
Map<String,String> parameters)
Create a payout batch resource by passing a sender_batch_header and an
items array to the request URI.
|
Webhook |
Webhook.create(APIContext apiContext,
Webhook webhook)
Creates the Webhook for the application associated with the access token.
|
CreateProfileResponse |
WebProfile.create(String accessToken)
Create a web experience profile by passing the name of the profile and other profile details in the request JSON to the request URI.
|
Plan |
Plan.create(String accessToken)
Create a new billing plan by passing the details for the plan, including the plan name, description, and type, to the request URI.
|
Payment |
Payment.create(String accessToken)
Creates (and processes) a new Payment Resource.
|
Invoice |
Invoice.create(String accessToken)
Creates a new invoice Resource.
|
CreditCard |
CreditCard.create(String accessToken)
Creates a new Credit Card Resource (aka Tokenize).
|
Agreement |
Agreement.create(String accessToken)
Create a new billing agreement by passing the details for the agreement, including the name, description, start date, payer, and billing plan in the request JSON.
|
PayoutBatch |
Payout.create(String accessToken,
Map<String,String> parameters)
Create a payout batch resource by passing a sender_batch_header and an
items array to the request URI.
|
Payment |
FuturePayment.create(String accessToken,
String correlationId)
Creates a future payment using either authorization code or refresh token with correlation ID.
|
Webhook |
Webhook.create(String accessToken,
Webhook webhook)
Creates the Webhook for the application associated with the access token.
|
PayoutBatch |
Payout.createSynchronous(APIContext apiContext)
You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.
|
PayoutBatch |
Payout.createSynchronous(String accessToken)
You can submit a payout with a synchronous API call, which immediately returns the results of a PayPal payment.
|
void |
WebProfile.delete(APIContext apiContext)
Delete an existing web experience profile by passing the profile ID to the request URI.
|
void |
Invoice.delete(APIContext apiContext)
Delete invoice resource for the given identifier.
|
void |
CreditCard.delete(APIContext apiContext)
Delete the Credit Card resource for the given identifier.
|
void |
Webhook.delete(APIContext apiContext,
String webhookId)
Deletes the Webhook identified by webhook_id for the application associated with access token.
|
void |
WebProfile.delete(String accessToken)
Delete an existing web experience profile by passing the profile ID to the request URI.
|
void |
Invoice.delete(String accessToken)
Delete invoice resource for the given identifier.
|
void |
CreditCard.delete(String accessToken)
Delete the Credit Card resource for the given identifier.
|
void |
Webhook.delete(String accessToken,
String webhookId)
Deletes the Webhook identified by webhook_id for the application associated with access token.
|
Order |
Order.doVoid(APIContext apiContext)
Voids (cancels) an Order.
|
Authorization |
Authorization.doVoid(APIContext apiContext)
Voids (cancels) an Authorization.
|
Order |
Order.doVoid(String accessToken)
Voids (cancels) an Order.
|
Authorization |
Authorization.doVoid(String accessToken)
Voids (cancels) an Authorization.
|
Payment |
Payment.execute(APIContext apiContext,
PaymentExecution paymentExecution)
Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal.
|
static Agreement |
Agreement.execute(APIContext apiContext,
String token)
Execute a billing agreement after buyer approval by passing the payment token to the request URI.
|
Agreement |
Agreement.execute(String accessToken)
Execute a billing agreement after buyer approval by passing the payment token to the request URI.
|
Payment |
Payment.execute(String accessToken,
PaymentExecution paymentExecution)
Executes the payment (after approved by the Payer) associated with this resource when the payment method is PayPal.
|
static WebProfile |
WebProfile.get(APIContext apiContext,
String profileId)
Retrieve the details of a particular web experience profile by passing the ID of the profile to the request URI.
|
Webhook |
Webhook.get(APIContext apiContext,
String webhookId)
Retrieves the Webhook identified by webhook_id for the application associated with access token.
|
static Sale |
Sale.get(APIContext apiContext,
String saleId)
Obtain the Sale transaction resource for the given identifier.
|
static Refund |
Refund.get(APIContext apiContext,
String refundId)
Obtain the Refund transaction resource for the given identifier.
|
static Plan |
Plan.get(APIContext apiContext,
String planId)
Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI.
|
static PayoutItemDetails |
PayoutItem.get(APIContext apiContext,
String payoutItemId)
Obtain the status of a payout item by passing the item ID to the request
URI.
|
static PayoutBatch |
Payout.get(APIContext apiContext,
String payoutBatchId)
Obtain the status of a specific batch resource by passing the payout
batch ID to the request URI.
|
static Payment |
Payment.get(APIContext apiContext,
String paymentId)
Obtain the Payment resource for the given identifier.
|
static Order |
Order.get(APIContext apiContext,
String orderId)
Obtain the Order resource for the given identifier.
|
static Invoice |
Invoice.get(APIContext apiContext,
String invoiceId)
Get the invoice resource for the given identifier.
|
static Event |
Event.get(APIContext apiContext,
String eventId)
Retrieves the Webhooks event resource identified by event_id.
|
static CreditCard |
CreditCard.get(APIContext apiContext,
String creditCardId)
Obtain the Credit Card resource for the given identifier.
|
static Capture |
Capture.get(APIContext apiContext,
String captureId)
Obtain the Capture transaction resource for the given identifier.
|
static Authorization |
Authorization.get(APIContext apiContext,
String authorizationId)
Obtain the Authorization transaction resource for the given identifier.
|
static Agreement |
Agreement.get(APIContext apiContext,
String agreementId)
Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI.
|
static WebProfile |
WebProfile.get(String accessToken,
String profileId)
Retrieve the details of a particular web experience profile by passing the ID of the profile to the request URI.
|
Webhook |
Webhook.get(String accessToken,
String webhookId)
Retrieves the Webhook identified by webhook_id for the application associated with access token.
|
static Sale |
Sale.get(String accessToken,
String saleId)
Obtain the Sale transaction resource for the given identifier.
|
static Refund |
Refund.get(String accessToken,
String refundId)
Obtain the Refund transaction resource for the given identifier.
|
static Plan |
Plan.get(String accessToken,
String planId)
Retrieve the details for a particular billing plan by passing the billing plan ID to the request URI.
|
static PayoutItemDetails |
PayoutItem.get(String accessToken,
String payoutItemId)
Obtain the status of a payout item by passing the item ID to the request
URI.
|
static PayoutBatch |
Payout.get(String accessToken,
String payoutBatchId)
Obtain the status of a specific batch resource by passing the payout
batch ID to the request URI.
|
static Payment |
Payment.get(String accessToken,
String paymentId)
Obtain the Payment resource for the given identifier.
|
static Order |
Order.get(String accessToken,
String orderId)
Obtain the Order resource for the given identifier.
|
static Invoice |
Invoice.get(String accessToken,
String invoiceId)
Get the invoice resource for the given identifier.
|
static Event |
Event.get(String accessToken,
String eventId)
Retrieves the Webhooks event resource identified by event_id.
|
static CreditCard |
CreditCard.get(String accessToken,
String creditCardId)
Obtain the Credit Card resource for the given identifier.
|
static Capture |
Capture.get(String accessToken,
String captureId)
Obtain the Capture transaction resource for the given identifier.
|
static Authorization |
Authorization.get(String accessToken,
String authorizationId)
Obtain the Authorization transaction resource for the given identifier.
|
static Agreement |
Agreement.get(String accessToken,
String agreementId)
Retrieve details for a particular billing agreement by passing the ID of the agreement to the request URI.
|
WebhookList |
WebhookList.getAll(APIContext apiContext)
Retrieves all Webhooks for the application associated with access token.
|
static Invoices |
Invoice.getAll(APIContext apiContext)
Get all invoices of a merchant.
|
WebhookList |
WebhookList.getAll(String accessToken)
Retrieves all Webhooks for the application associated with access token.
|
static Invoices |
Invoice.getAll(String accessToken)
Get all invoices of a merchant.
|
static List<WebProfile> |
WebProfile.getList(APIContext apiContext)
Lists all web experience profiles that exist for a merchant (or subject).
|
static List<WebProfile> |
WebProfile.getList(String accessToken)
Lists all web experience profiles that exist for a merchant (or subject).
|
Tokeninfo |
FuturePayment.getTokeninfo(CreateFromAuthorizationCodeParameters params) |
Tokeninfo |
FuturePayment.getTokeninfo(CreateFromRefreshTokenParameters params,
Tokeninfo info) |
static OAuthTokenCredential |
WebProfile.initConfig(File file)
Initialize using a File(Properties file)
|
static OAuthTokenCredential |
WebProfile.initConfig(InputStream is)
Initialize using InputStream(of a Properties file)
|
static PlanList |
Plan.list(APIContext apiContext,
Map<String,String> containerMap)
List billing plans according to optional query string parameters specified.
|
static PaymentHistory |
Payment.list(APIContext apiContext,
Map<String,String> containerMap)
Retrieves a list of Payment resources.
|
static CreditCardHistory |
CreditCard.list(APIContext apiContext,
Map<String,String> containerMap)
Retrieves a list of Credit Card resources.
|
static EventList |
Event.list(APIContext apiContext,
String queryParams)
Retrieves the list of Webhooks events resources for the application associated with token.
|
static CreditCardHistory |
CreditCard.list(String accessToken)
Retrieves a list of Credit Card resources.
|
static PlanList |
Plan.list(String accessToken,
Map<String,String> containerMap)
List billing plans according to optional query string parameters specified.
|
static PaymentHistory |
Payment.list(String accessToken,
Map<String,String> containerMap)
Retrieves a list of Payment resources.
|
static CreditCardHistory |
CreditCard.list(String accessToken,
Map<String,String> containerMap)
Retrieves a list of Credit Card resources.
|
static EventList |
Event.list(String accessToken,
String queryParams)
Retrieves the list of Webhooks events resources for the application associated with token.
|
void |
WebProfile.partialUpdate(APIContext apiContext,
PatchRequest patchRequest)
Partially update an existing web experience profile by passing the ID of the profile to the request URI.
|
void |
WebProfile.partialUpdate(String accessToken,
PatchRequest patchRequest)
Partially update an existing web experience profile by passing the ID of the profile to the request URI.
|
void |
Agreement.reActivate(APIContext apiContext,
AgreementStateDescriptor agreementStateDescriptor)
Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI.
|
void |
Agreement.reActivate(String accessToken,
AgreementStateDescriptor agreementStateDescriptor)
Reactivate a suspended billing agreement by passing the ID of the agreement to the appropriate URI.
|
Authorization |
Authorization.reauthorize(APIContext apiContext)
Reauthorizes an expired Authorization.
|
Authorization |
Authorization.reauthorize(String accessToken)
Reauthorizes an expired Authorization.
|
void |
Invoice.recordPayment(APIContext apiContext,
PaymentDetail paymentDetail)
Mark the status of the invoice as paid.
|
void |
Invoice.recordPayment(String accessToken,
PaymentDetail paymentDetail)
Mark the status of the invoice as paid.
|
void |
Invoice.recordRefund(APIContext apiContext,
RefundDetail refundDetail)
Mark the status of the invoice as refunded.
|
void |
Invoice.recordRefund(String accessToken,
RefundDetail refundDetail)
Mark the status of the invoice as refunded.
|
Refund |
Sale.refund(APIContext apiContext,
Refund refund)
Creates (and processes) a new Refund Transaction added as a related resource.
|
Refund |
Capture.refund(APIContext apiContext,
Refund refund)
Creates (and processes) a new Refund Transaction added as a related resource.
|
Refund |
Sale.refund(String accessToken,
Refund refund)
Creates (and processes) a new Refund Transaction added as a related resource.
|
Refund |
Capture.refund(String accessToken,
Refund refund)
Creates (and processes) a new Refund Transaction added as a related resource.
|
void |
Invoice.remind(APIContext apiContext,
Notification notification)
Reminds the payer to pay the invoice.
|
void |
Invoice.remind(String accessToken,
Notification notification)
Reminds the payer to pay the invoice.
|
Event |
Event.resend(APIContext apiContext)
Resends the Webhooks event resource identified by event_id.
|
Event |
Event.resend(String accessToken)
Resends the Webhooks event resource identified by event_id.
|
Invoices |
Invoice.search(APIContext apiContext,
Search search)
Search for invoice resources.
|
Invoices |
Invoice.search(String accessToken,
Search search)
Search for invoice resources.
|
void |
Invoice.send(APIContext apiContext)
Sends a legitimate invoice to the payer.
|
void |
Invoice.send(String accessToken)
Sends a legitimate invoice to the payer.
|
void |
Agreement.setBalance(APIContext apiContext,
Currency currency)
Set the balance for an agreement by passing the ID of the agreement to the request URI.
|
void |
Agreement.setBalance(String accessToken,
Currency currency)
Set the balance for an agreement by passing the ID of the agreement to the request URI.
|
static EventTypeList |
EventType.subscribedEventTypes(APIContext apiContext,
String webhookId)
Retrieves the list of events-types subscribed by the given Webhook.
|
static EventTypeList |
EventType.subscribedEventTypes(String accessToken,
String webhookId)
Retrieves the list of events-types subscribed by the given Webhook.
|
void |
Agreement.suspend(APIContext apiContext,
AgreementStateDescriptor agreementStateDescriptor)
Suspend a particular billing agreement by passing the ID of the agreement to the request URI.
|
void |
Agreement.suspend(String accessToken,
AgreementStateDescriptor agreementStateDescriptor)
Suspend a particular billing agreement by passing the ID of the agreement to the request URI.
|
static AgreementTransactions |
Agreement.transactions(APIContext apiContext,
String agreementId,
Date startDate,
Date endDate)
List transactions for a billing agreement by passing the ID of the agreement, as well as the start and end dates of the range of transactions to list, to the request URI.
|
static AgreementTransactions |
Agreement.transactions(String accessToken,
String agreementId,
Date startDate,
Date endDate)
List transactions for a billing agreement by passing the ID of the agreement, as well as the start and end dates of the range of transactions to list, to the request URI.
|
void |
WebProfile.update(APIContext apiContext)
Update a web experience profile by passing the ID of the profile to the request URI.
|
Invoice |
Invoice.update(APIContext apiContext)
Full update of the invoice resource for the given identifier.
|
void |
Plan.update(APIContext apiContext,
List<Patch> patchRequest)
Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI.
|
void |
Payment.update(APIContext apiContext,
List<Patch> patchRequest)
Partially update a payment resource by by passing the payment_id in the request URI.
|
CreditCard |
CreditCard.update(APIContext apiContext,
List<Patch> patchRequest)
Update information in a previously saved card.
|
Agreement |
Agreement.update(APIContext apiContext,
List<Patch> patchRequest)
Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI.
|
Webhook |
Webhook.update(APIContext apiContext,
String webhookId,
String patchRequest)
Updates the Webhook identified by webhook_id for the application associated with access token.
|
void |
WebProfile.update(String accessToken)
Update a web experience profile by passing the ID of the profile to the request URI.
|
Invoice |
Invoice.update(String accessToken)
Full update of the invoice resource for the given identifier.
|
void |
Plan.update(String accessToken,
List<Patch> patchRequest)
Replace specific fields within a billing plan by passing the ID of the billing plan to the request URI.
|
void |
Payment.update(String accessToken,
List<Patch> patchRequest)
Partially update a payment resource by by passing the payment_id in the request URI.
|
CreditCard |
CreditCard.update(String accessToken,
List<Patch> patchRequest)
Update information in a previously saved card.
|
Agreement |
Agreement.update(String accessToken,
List<Patch> patchRequest)
Update details of a billing agreement, such as the description, shipping address, and start date, by passing the ID of the agreement to the request URI.
|
Webhook |
Webhook.update(String accessToken,
String webhookId,
String patchRequest)
Updates the Webhook identified by webhook_id for the application associated with access token.
|
static boolean |
Event.validateReceivedEvent(APIContext apiContext,
Map<String,String> headers,
String requestBody)
Validates received event received from PayPal to webhook endpoint set for particular webhook Id with PayPal trust source, to verify Data and Certificate integrity.
|
| Modifier and Type | Method and Description |
|---|---|
static InputStream |
SSLUtil.downloadCertificateFromPath(String urlPath)
Downloads Certificate from URL
|
static Collection<X509Certificate> |
SSLUtil.getCertificateFromStream(InputStream stream)
Generate Collection of Certificate from Input Stream
|
static String |
SDKUtil.validateAndGet(Map<String,String> map,
String key)
Utility method to validate if the key exists in the provided map, and returns string value of the object
|
static boolean |
SSLUtil.validateCertificateChain(Collection<X509Certificate> clientCerts,
Collection<X509Certificate> trustCerts,
String authType)
Performs Certificate Chain Validation on provided certificates.
|
| Modifier and Type | Method and Description |
|---|---|
protected static PayPalRESTException |
PayPalRESTException.createFromHttpErrorException(HttpErrorException httpErrorException)
Utility method that creates a
PayPalRESTException object from HttpErrorException. |
| Modifier and Type | Method and Description |
|---|---|
static <T> T |
PayPalResource.configureAndExecute(APIContext apiContext,
HttpMethod httpMethod,
String resourcePath,
Map<String,String> headersMap,
String payLoad,
Class<T> clazz)
Deprecated.
|
static <T> T |
PayPalResource.configureAndExecute(APIContext apiContext,
HttpMethod httpMethod,
String resourcePath,
String payLoad,
Class<T> clazz)
Configures and executes REST call: Supports JSON
|
static <T> T |
PayPalResource.configureAndExecute(String accessToken,
HttpMethod httpMethod,
String resourcePath,
String payLoad,
Class<T> clazz)
Deprecated.
|
static String |
RESTUtil.formatURIPath(String pattern,
Map<String,String> pathParameters)
Formats the URI path for REST calls.
|
static String |
RESTUtil.formatURIPath(String pattern,
Map<String,String> pathParameters,
Map<String,String> queryParameters)
Formats the URI path for REST calls.
|
String |
OAuthTokenCredential.getAccessToken()
Computes Access Token by placing a call to OAuth server using ClientID
and ClientSecret.
|
String |
OAuthTokenCredential.getAuthorizationHeader()
Computes Access Token by doing a Base64 encoding on the ClientID and
ClientSecret.
|
static OAuthTokenCredential |
PayPalResource.initConfig(File file)
Initialize the system using a File(Properties file).
|
static OAuthTokenCredential |
PayPalResource.initConfig(InputStream inputStream)
Initialize using
InputStream(of a Properties file).. |
static void |
PayPalResource.initializeToDefault()
Initialize to default properties
|
Copyright © 2015. All Rights Reserved.