public class Event
extends java.lang.Object
Represents a event resource returned from the API.
Events are stored for all webhooks. An event refers to a resource which has been updated, for example a payment which has been collected, or a mandate which has been transferred.
| Modifier and Type | Class and Description |
|---|---|
static class |
Event.CustomerNotification |
static class |
Event.Details |
static class |
Event.Links |
static class |
Event.ResourceType |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAction()
What has happened to the resource.
|
java.lang.String |
getCreatedAt()
Fixed timestamp, recording when this resource was created.
|
java.util.List<Event.CustomerNotification> |
getCustomerNotifications()
Present only in webhooks when an integrator is authorised to send their own notifications.
|
Event.Details |
getDetails() |
java.lang.String |
getId()
Unique identifier, beginning with “EV”.
|
Event.Links |
getLinks() |
java.util.Map<java.lang.String,java.lang.String> |
getMetadata()
If the
details[origin] is api, this will contain any metadata you specified when triggering this event. |
Event.ResourceType |
getResourceType()
The resource type for this event.
|
public java.lang.String getAction()
What has happened to the resource.
public java.lang.String getCreatedAt()
Fixed timestamp, recording when this resource was created.
public java.util.List<Event.CustomerNotification> getCustomerNotifications()
Present only in webhooks when an integrator is authorised to send their own notifications. See here for further information.
public Event.Details getDetails()
public java.lang.String getId()
Unique identifier, beginning with “EV”.
public Event.Links getLinks()
public java.util.Map<java.lang.String,java.lang.String> getMetadata()
If the details[origin] is api, this will contain any metadata you specified when triggering this event. In other cases it will be an empty object.
public Event.ResourceType getResourceType()
The resource type for this event. One of:
paymentsmandatespayoutsrefundssubscriptions