An Event refers to a resource which has been updated - for example, a Payment has been paid out, or a Refund has been settled (see full list of events here).
You can export Events data from the dashboard by navigating to the Developers Events page, and selecting Export in the top right corner.
Note, you can filter the export using the tool at the top of the page.
| COLUMN | DATA | DESCRIPTION |
|---|---|---|
|
A |
id |
Event ID |
|
B |
created_at |
Date the event was created |
|
C |
resource_type |
The type of resource the events relates to, for example payouts, mandates or payments |
|
D |
action |
The action the event relates to, for example created, submitted or paid |
|
E |
details.origin |
The origin of the event, for example dashboard or api |
|
F |
details.cause |
Cause of the event, for example payout_paid |
|
G |
details.description |
Further details about the event |
|
H |
details.scheme |
Scheme related to the event (if applicable) |
|
I |
details.reason_code |
Reason code (if applicable) |
|
J |
links.previous_customer_bank_account |
Previous customer bank account (if applicable, for example if a customer were to update their bank account details) |
|
K |
links.new_customer_bank_account |
New customer bank account (if applicable, for example if a customer were to update their bank account details) |
|
L |
links.parent_event |
Event ID linked to this event (if applicable) |
|
M |
links.payment |
Payment ID linked to this event (if applicable) |
|
N |
links.subscription |
Subscription ID linked to this event (if applicable) |
|
O |
links.mandate |
Mandate ID linked to this event (if applicable) |
|
P |
links.refund |
Refund ID linked to this event (if applicable) |
|
Q |
links.payout |
Payout ID linked to this event (if applicable) |
|
R |
links.new_mandate |
Mandate ID (if mandate has been replaced, not always applicable) |
The Events export can contain data from the following APIs:
Events