Docs

Subscribe to notifications for payouts

Subscribe to notifications for payouts for Paddle to get notified when payouts are initiated and paid.

Tooling

  • API
  • Webhooks

Released

September 8, 2023

Status

Released

API version

Version 1

What's new?

We added two new events that you can subscribe to:

  • payout.created

    Occurs when a payout from Paddle is initiated. This means the transfer of money is in progress.

  • payout.paid

    Occurs when a payout is paid. This means it has been paid into your bank, so you should see it the next working day.

How it works

Paddle initiates payouts on the 1st of each month. They're usually completed some time between the 2nd-15th of the month.

You can track payouts from the Paddle dashboard by going to Paddle > Business account > Payouts.

The new payment.created and payment.paid events let you subscribe to notifications for payouts, meaning you can build workflows using your payout data. For example, you could pipe data to your accounting solution or create a notification in Slack.

Examples

YAML
summary: payout.paid
value:
event_id: evt_01h2b0tqg1xkgnkfmprsnrjn0s
event_type: payout.paid
occurred_at: "2023-06-07T13:30:38.138984Z"
notification_id: ntf_01h2b0tqkhfqd094y9pys30xyw
data:
id: payout_01gsz4vmqbjk3x4vvtafffd540
remittance_reference: "10374"
status: paid
amount: "10000"
currency_code: USD

Next steps

This change is available in version 1 of the Paddle API.

It's a non-breaking change, meaning it doesn't impact existing integrations.

You can create a notification destination for the new payout events by going to Paddle > Developer tools > Notifications, or by using the create a notification destination operation in the Paddle API.

Summary of changes

Entity Field Change Type
Payouts payout.created + Added Webhook
Payouts payout.paid + Added Webhook

Was this page helpful?