- Payout breakdown - Events associated with a single Payout
- Payout breakdown - Events associated with multiple Payouts
Payout breakdown - Events associated with a single Payout
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). When transactions such as Payments or Refunds are included in a payout, the corresponding Event will be logged. The Payouts - Events export will give you a breakdown of all Events associated with the selected Payout.
You can export Payout Events data from the dashboard by navigating to the Payments Payouts page, opening the desired Payout, and selecting Payout breakdown Export Events in the top right corner.
| COLUMN | DATA | DESCRIPTION |
|---|---|---|
|
A |
id |
Event ID |
|
B |
created_at |
Date the event was created |
|
C |
resource_type |
The type of resource the event relates to |
|
D |
action |
The action take in the event |
|
E & F |
credit_amount & debit_amount |
The amount credited or debited (if applicable) |
|
G |
details.origin |
Origin of the event |
|
H |
details.cause |
What caused the event |
|
I |
details.description |
Description of the cause |
|
J |
links.parent_event |
Main event this event is linked to |
|
K |
links.payment |
Linked payment ID to the event (if applicable) |
|
L |
links.customer |
Linked customer ID to the event (if applicable) |
|
M |
links.payout |
Linked payout ID to the event (if applicable) |
|
N |
links.refund |
Linked refund ID to the event (if applicable) |
|
O |
payments.id |
Linked payment ID |
|
P |
payments.created_at |
Date the payment was created |
|
Q |
payments.charge_date |
Date the payment was collected from the customer |
|
R |
payments.amount |
Payment amount |
|
S |
payments.description |
Payment description |
|
T |
payments.currency |
Payment currency |
|
U |
payments.status |
Current payment status |
|
V |
payments.amount_refunded |
Refunded payment amount (if applicable) |
|
W |
payments.reference |
Payment reference (if applicable) |
|
X |
payments.links.mandate |
Mandate ID linked to the payment |
|
Y |
payments.links.creditor |
Creditor ID linked to the payment |
|
Z |
payments.links.customer |
Customer ID linked to the payment |
|
AA |
payments.links.payout |
Payout ID linked to the payment |
|
AB |
payments.links.subscription |
Subscription ID linked to the payment (if applicable) |
|
AC - AQ |
Various |
Customer details, such as Customer ID, name & address. |
|
AR - AX |
Various |
Refund details (if applicable) |
|
AY onwards |
Various |
Metadata (if applicable) |
The Payout - Events export contains data from the following APIs:
Payout breakdown - Events associated with multiple Payouts
In addition to exporting the Events associated with a single Payout, you can also export the Events associated with multiple Payouts using the Payout Reconciliation option on the Payments Payouts page.
| COLUMN | DATA | DESCRIPTION |
|---|---|---|
|
A |
id |
Event ID |
|
B |
created_at |
Date the event was created |
|
C |
resource_type |
The type of resource the event relates to |
|
D |
action |
The action take in the event |
|
E & F |
credit_amount & debit_amount |
The amount credited or debited (if applicable) |
|
G |
details.origin |
Origin of the event |
|
H |
details.cause |
What caused the event |
|
I |
details.description |
Description of the cause |
|
J |
links.parent_event |
Main event this event is linked to |
|
K |
links.payment |
Linked payment ID to the event (if applicable) |
|
L |
links.customer |
Linked customer ID to the event (if applicable) |
|
M |
links.payout |
Linked payout ID to the event (if applicable) |
|
N |
links.refund |
Linked refund ID to the event (if applicable) |
|
O |
payments.id |
Linked payment ID |
|
P |
payments.created_at |
Date the payment was created |
|
Q |
payments.charge_date |
Date the payment was collected from the customer |
|
R |
payments.amount |
Payment amount |
|
S |
payments.description |
Payment description |
|
T |
payments.currency |
Payment currency |
|
U |
payments.status |
Current payment status |
|
V |
payments.amount_refunded |
Refunded payment amount (if applicable) |
|
W |
payments.reference |
Payment reference (if applicable) |
|
X |
payments.links.mandate |
Mandate ID linked to the payment |
|
Y |
payments.links.creditor |
Creditor ID linked to the payment |
|
Z |
payments.links.customer |
Customer ID linked to the payment |
|
AA |
payments.links.payout |
Payout ID linked to the payment |
|
AB |
payments.links.subscription |
Subscription ID linked to the payment (if applicable) |
|
AC - AQ |
Various |
Customer details, such as Customer ID, name & address. |
|
AR - AX |
Various |
Refund details (if applicable) |
|
AY |
payouts.reference |
Payout reference |
|
AZ |
payouts.arrival_date |
Date the payout arrived in your payout bank account |
|
BA - onwards |
Various |
Metadata (if applicable) |
The Payout Reconciliation - Events export contains data from the following APIs: