com.paypal.api.payments

Class Event

java.lang.Object

com.paypal.base.rest.PayPalModel

com.paypal.base.rest.PayPalResource

com.paypal.api.payments.Event

public class Event
extends PayPalResource

Constructor Summary

Constructors

Constructor and Description
Event() Default Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static Event	get(APIContext apiContext, String eventId) Retrieves the Webhooks event resource identified by event_id.
static Event	get(String accessToken, String eventId) Retrieves the Webhooks event resource identified by event_id.
String	getCreateTime() Getter for createTime
String	getEventType() Getter for eventType
String	getId() Getter for id
List<Links>	getLinks() Getter for links
Object	getResource() Getter for resource
String	getResourceType() Getter for resourceType
String	getSummary() Getter for summary
static EventList	list(APIContext apiContext, String queryParams) Retrieves the list of Webhooks events resources for the application associated with token.
static EventList	list(String accessToken, String queryParams) Retrieves the list of Webhooks events resources for the application associated with token.
Event	resend(APIContext apiContext) Resends the Webhooks event resource identified by event_id.
Event	resend(String accessToken) Resends the Webhooks event resource identified by event_id.
Event	setCreateTime(String createTime) Setter for createTime
Event	setEventType(String eventType) Setter for eventType
Event	setId(String id) Setter for id
Event	setLinks(List<Links> links) Setter for links
Event	setResource(Object resource) Setter for resource
Event	setResourceType(String resourceType) Setter for resourceType
Event	setSummary(String summary) Setter for summary
static boolean	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.

Methods inherited from class com.paypal.base.rest.PayPalResource

configureAndExecute, configureAndExecute, configureAndExecute, createAPICallPreHandler, getClientID, getClientSecret, getConfigurations, getLastRequest, getLastResponse, getOAuthTokenCredential, initConfig, initConfig, initConfig, initializeToDefault

Methods inherited from class com.paypal.base.rest.PayPalModel

equals, hashCode, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Event

public Event()

Default Constructor

Method Detail

setId

public Event setId(String id)

Setter for id

getId

public String getId()

Getter for id

setCreateTime

public Event setCreateTime(String createTime)

Setter for createTime

getCreateTime

public String getCreateTime()

Getter for createTime

setResourceType

public Event setResourceType(String resourceType)

Setter for resourceType

getResourceType

public String getResourceType()

Getter for resourceType

setEventType

public Event setEventType(String eventType)

Setter for eventType

getEventType

public String getEventType()

Getter for eventType

setSummary

public Event setSummary(String summary)

Setter for summary

getSummary

public String getSummary()

Getter for summary

setResource

public Event setResource(Object resource)

Setter for resource

getResource

public Object getResource()

Getter for resource

setLinks

public Event setLinks(List<Links> links)

Setter for links

getLinks

public List<Links> getLinks()

Getter for links

get

public static Event get(String accessToken,
        String eventId)
                 throws PayPalRESTException

Retrieves the Webhooks event resource identified by event_id. Can be used to retrieve the payload for an event.

Parameters:

accessToken - Access Token used for the API call.

eventId - String

Returns:

Event

Throws:

PayPalRESTException

get

public static Event get(APIContext apiContext,
        String eventId)
                 throws PayPalRESTException

Retrieves the Webhooks event resource identified by event_id. Can be used to retrieve the payload for an event.

Parameters:

apiContext - APIContext used for the API call.

eventId - String

Returns:

Event

Throws:

PayPalRESTException

resend

public Event resend(String accessToken)
             throws PayPalRESTException

Resends the Webhooks event resource identified by event_id.

Parameters:

accessToken - Access Token used for the API call.

Returns:

Event

Throws:

PayPalRESTException

resend

public Event resend(APIContext apiContext)
             throws PayPalRESTException

Resends the Webhooks event resource identified by event_id.

Parameters:

apiContext - APIContext used for the API call.

Returns:

Event

Throws:

PayPalRESTException

list

public static EventList list(String accessToken,
             String queryParams)
                      throws PayPalRESTException

Retrieves the list of Webhooks events resources for the application associated with token. The developers can use it to see list of past webhooks events.

Parameters:

accessToken - Access Token used for the API call.

Returns:

EventList

Throws:

PayPalRESTException

list

public static EventList list(APIContext apiContext,
             String queryParams)
                      throws PayPalRESTException

Retrieves the list of Webhooks events resources for the application associated with token. The developers can use it to see list of past webhooks events.

Parameters:

apiContext - APIContext used for the API call.

Returns:

EventList

Throws:

PayPalRESTException

validateReceivedEvent

public static boolean validateReceivedEvent(APIContext apiContext,
                            Map<String,String> headers,
                            String requestBody)
                                     throws PayPalRESTException,
                                            InvalidKeyException,
                                            NoSuchAlgorithmException,
                                            SignatureException

Validates received event received from PayPal to webhook endpoint set for particular webhook Id with PayPal trust source, to verify Data and Certificate integrity. It validates both certificate chain, as well as data integrity.

Parameters:

apiContext - APIContext object

headers - Map of Headers received in the event, from request

requestBody - Request body received in the provided webhook

Returns:

true if valid, false otherwise

Throws:

PayPalRESTException

InvalidKeyException

NoSuchAlgorithmException

SignatureException