GoCardlessEvent Class |
Event object to pass information about an event.
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.
Corresponds directly to GoCardless Events object https://developer.gocardless.com/api-reference/#core-endpoints-events.
Inheritance HierarchyNamespace: NetQuarry.Services.Payment
Assembly: EAP.Core (in EAP.Core.dll) Version: 2.0.0.0 (4.6.8.0)
SyntaxThe GoCardlessEvent type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GoCardlessEvent |
Empty constructor.
|
| GoCardlessEvent(String) |
Constructor with idempotency key.
|
Properties| Name | Description | |
|---|---|---|
 | action |
What has happened to the resource.
|
| created_at |
Fixed timestamp, recording when this resource was created.
|
| details |
Details about the event. Is always sent when GC gives us info.
|
| id |
Unique identifier, beginning with “EV”.
|
| IDEMPOTENCYKEY |
Not part of actual object sent to GoCardless. Used in HTTP header to prevent duplicating a successful request.
|
| include |
Used in List Event API.
If set, includes linked resources in the response.
Must be used with the resource_type parameter specified.
The include should be one from GoCardlessEventinclude_options.
|
| linked_mandate |
For list events endpoint. Set if include was sent in request.
GoCardless doesn't send linked objects here but have these properties for passing an event to the application without needing a wrapper class.
|
| linked_payment |
For list events endpoint. Set if include was sent in request.
GoCardless doesn't send linked objects here but have these properties for passing an event to the application without needing a wrapper class.
|
| linked_refund |
For list events endpoint. Set if include was sent in request.
GoCardless doesn't send linked objects here but have these properties for passing an event to the application without needing a wrapper class.
|
| links |
IDs of things that could be related:
mandate, new_mandate, organisation, parent_event.
|
| metadata |
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.
|
| resource_type |
The resource type for this event.
One from GoCardlessEventresource_type_options.
|
Methods| Name | Description | |
|---|---|---|
| Equals | (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ToString | (Inherited from Object.) |
Extension Methods| Name | Description | |
|---|---|---|
 | EqualValue |
Determines if the object value is equal to another object. If the two objects are null, then this returns true.
There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways).
If the special guid handling is not performed, then the object.Equals method is used.
(Defined by EAPUtil.) |
See Also