Event Properties |
The GoCardlessEvent type exposes the following members.
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.
|
See Also