Occurs when a payout is paid. This is usually the working day before the funds credit your account.
event_idstringrequired
Example:
evt_01gks14ge726w50ch2tmaw2a1xUnique Paddle ID for this event, prefixed with
evt_.Pattern:
^evt_[a-z\d]{26}$event_typestringrequired
Type of event sent by Paddle, in the format
entity.event_type.Values
address.createdAnaddress.createdevent.address.importedAnaddress.importedevent.address.updatedAnaddress.updatedevent.adjustment.createdAnadjustment.createdevent.adjustment.updatedAnadjustment.updatedevent.
+ Show all values− Hide values
api_key.createdAnapi_key.createdevent.api_key.expiredAnapi_key.expiredevent.api_key.expiringAnapi_key.expiringevent.api_key.revokedAnapi_key.revokedevent.api_key.updatedAnapi_key.updatedevent.api_key_exposure.createdAnapi_key_exposure.createdevent.business.createdAbusiness.createdevent.business.importedAbusiness.importedevent.business.updatedAbusiness.updatedevent.client_token.createdAclient_token.createdevent.client_token.revokedAclient_token.revokedevent.client_token.updatedAclient_token.updatedevent.customer.createdAcustomer.createdevent.customer.importedAcustomer.importedevent.customer.updatedAcustomer.updatedevent.discount.createdAdiscount.createdevent.discount.importedAdiscount.importedevent.discount.updatedAdiscount.updatedevent.discount_group.createdAdiscount_group.createdevent.discount_group.updatedAdiscount_group.updatedevent.payment_method.savedApayment_method.savedevent.payment_method.deletedApayment_method.deletedevent.payout.createdApayout.createdevent.payout.paidApayout.paidevent.price.createdAprice.createdevent.price.importedAprice.importedevent.price.updatedAprice.updatedevent.product.createdAproduct.createdevent.product.importedAproduct.importedevent.product.updatedAproduct.updatedevent.report.createdAreport.createdevent.report.updatedAreport.updatedevent.subscription.activatedAsubscription.activatedevent.subscription.canceledAsubscription.canceledevent.subscription.createdAsubscription.createdevent.subscription.importedAsubscription.importedevent.subscription.past_dueAsubscription.past_dueevent.subscription.pausedAsubscription.pausedevent.subscription.resumedAsubscription.resumedevent.subscription.trialingAsubscription.trialingevent.subscription.updatedAsubscription.updatedevent.transaction.billedAtransaction.billedevent.transaction.canceledAtransaction.canceledevent.transaction.completedAtransaction.completedevent.transaction.createdAtransaction.createdevent.transaction.paidAtransaction.paidevent.transaction.past_dueAtransaction.past_dueevent.transaction.payment_failedAtransaction.payment_failedevent.transaction.readyAtransaction.readyevent.transaction.revisedAtransaction.revisedevent.transaction.updatedAtransaction.updatedevent.
occurred_atstring (date-time)required
Example:
2024-10-12T07:20:50.52ZRFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example:
ntf_01ghbkd0frb9k95cnhwd1bxpvkUnique Paddle ID for this notification, prefixed with
ntf_.Pattern:
^ntf_[a-z\d]{26}$dataobjectrequired
New or changed entity.
idstringrequired
The ID associated with this payout
statusstringrequired
The current status of a payout
Values
unpaidPayout is unpaid. Typically means it has been created, but is not yet completed.paidPayout is paid.
amountstringrequired
The amount paid, or due to be paid to your bank account
currency_codestringrequired
Supported three-letter ISO 4217 currency code for payouts from Paddle.
Values
AUDAustralian DollarCADCanadian DollarCHFSwiss FrancCNYChinese YuanCZKCzech Koruna
+ Show all values− Hide values
DKKDanish KroneEUREuroGBPPound SterlingHUFHungarian ForintPLNPolish ZlotySEKSwedish KronaUSDUnited States DollarZARSouth African Rand
remittance_referencestringrequired
Reference number on the payout and remittance advice document
{ "event_id": "evt_01h2b0tqg1xkgnkfmprsnrjn0s", "event_type": "payout.paid", "occurred_at": "2023-06-07T13:30:38.138984Z", "notification_id": "ntf_01h2b0tqkhfqd094y9pys30xyw", "data": { "id": "payout_01gsz4vmqbjk3x4vvtafffd540", "status": "paid", "amount": "10000", "currency_code": "USD", "remittance_reference": "10374" }}