Event Types
type has the form {object}.{state}. data always holds the full object; read its status and status_code for the exact state. See the event object for the shape of data.Payments
| Type | Sent when the payment becomes |
|---|---|
payment.completed | partially_paid, paid or overpaid — any successful payment, including a later correction of the paid amount. |
payment.declined | declined. The reason is in data.status_code. |
payment.canceled | canceled. Who canceled it is in data.status_code. |
payment.expired | expired: the payment was not paid in time. |
payment.refunded | partially_refunded or refunded. The refunded total is in data.refunded. |
declined if the payment is revoked after review. You receive payment.declined with the newer created_at in that case.Payouts
| Type | Sent when the payout becomes |
|---|---|
payout.completed | partially_paid, paid or overpaid. |
payout.declined | declined. The reason is in data.status_code. |
payout.canceled | canceled. Who canceled it is in data.status_code. |
payout.expired | expired. |
Appeals
| Type | Sent when the appeal becomes |
|---|---|
appeal.approved | approved. The confirmed amount is in data.resolved. |
appeal.rejected | rejected. The reason is in data.status_code. |
appeal.canceled | canceled. The reason is in data.status_code. |