Payout
The payload sent to your webhook endpoint when a payout is created or changes status, and how to reconcile each payout lifecycle event.
Payout Webhook Events
A payout emits an event at each stage of its lifecycle. The stages match the payout statuses shown in your dashboard.payout.created was previously emitted as payout.not_initiated. If an existing endpoint filters on payout.not_initiated, update the filter to payout.created so it keeps matching. The status field on the payload still reports not_initiated at this stage.Handling Payout Events
Payouts are about your own money rather than a customer’s, so these events usually feed bookkeeping and internal alerting rather than customer-facing flows.Payout Status
The payout object reports its progress through a single field:refunds, chargebacks, and tax on the payload are deprecated. Use the payout breakup endpoints for a detailed breakdown instead.Related
Payout Structure
Balances & Wallets
Webhook Payload Schema
The total amount of the payout.
The unique identifier of the business associated with the payout.
The total value of chargebacks associated with the payout.
The timestamp when the payout was created, in UTC.
The currency of the payout, represented as an ISO 4217 currency code.
AED, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BWP, BYN, BZD, CAD, CHF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SZL, THB, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZAR, ZMW The fee charged for processing the payout.
The payment method used for the payout (e.g., bank transfer, card, etc.).
The unique identifier of the payout.
The total value of refunds associated with the payout.
The current status of the payout.
not_initiated, in_progress, on_hold, failed, success The tax applied to the payout.
The timestamp when the payout was last updated, in UTC.
The name of the payout recipient or purpose.
The URL of the document associated with the payout.
Any additional remarks or notes associated with the payout.