Docs

payout.created

Occurs when a payout is initiated by Paddle.

Occurs when a payout is initiated by Paddle. The payout status starts as unpaid. payout.paid occurs when the payout is processed and funds are on their way to your bank account.

event_idstringrequired
Example: evt_01gks14ge726w50ch2tmaw2a1x
Unique 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
+ Show all values
occurred_atstring (date-time)required
Example: 2024-10-12T07:20:50.52Z
RFC 3339 datetime string of when this event occurred.
notification_idstringrequired
Example: ntf_01ghbkd0frb9k95cnhwd1bxpvk
Unique 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
  • unpaid
    Payout is unpaid. Typically means it has been created, but is not yet completed.
  • paid
    Payout 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
  • AUD
    Australian Dollar
  • CAD
    Canadian Dollar
  • CHF
    Swiss Franc
  • CNY
    Chinese Yuan
  • CZK
    Czech Koruna
+ Show all values
  • DKK
    Danish Krone
  • EUR
    Euro
  • GBP
    Pound Sterling
  • HUF
    Hungarian Forint
  • PLN
    Polish Zloty
  • SEK
    Swedish Krona
  • USD
    United States Dollar
  • ZAR
    South African Rand
remittance_referencestringrequired
Reference number on the payout and remittance advice document
payout.created
{
  "event_id": "evt_01h2b06f69w9aw3eymqs1dfa2q",
  "event_type": "payout.created",
  "occurred_at": "2023-06-01T13:30:38.138984Z",
  "notification_id": "ntf_01h2b06f84qsjzdw8rywe3j4gt",
  "data": {
    "id": "payout_01gsz4vmqbjk3x4vvtafffd540",
    "status": "unpaid",
    "amount": "10000",
    "currency_code": "USD",
    "remittance_reference": "10374"
  }
}

Was this page helpful?