Skip to main content
Payout webhook आपको बताते हैं कि आपका अपना पैसा Dodo Payments से आपके bank account में कब स्थानांतरित होता है। Accounting systems में payouts का मिलान करने के लिए इनका उपयोग करें, ताकि List Payouts endpoint को बार-बार poll न करना पड़े।

Payout Webhook Events

Payout अपने lifecycle के प्रत्येक चरण पर एक event emit करता है। ये चरण आपके dashboard में दिखाए गए payout statuses से मेल खाते हैं।
payout.created को पहले payout.not_initiated के रूप में emit किया जाता था। यदि कोई मौजूदा endpoint payout.not_initiated पर filter करता है, तो filter को payout.created पर अपडेट करें, ताकि उसका मिलान जारी रहे। Payload में मौजूद status field इस चरण पर भी not_initiated report करती है।

Payout Events को संभालना

Payout आपके अपने पैसे से संबंधित होते हैं, customer के पैसे से नहीं। इसलिए ये events आम तौर पर customer-facing flows के बजाय bookkeeping और internal alerting में उपयोग किए जाते हैं।
Handling payout events
Processing से पहले हमेशा webhook signature verify करें — setup के लिए Webhooks guide देखें। संक्षिप्तता के लिए ऊपर दिए गए handler में verification शामिल नहीं है।
Payout events न तो terminal होते हैं और न ही इनका क्रम सख्ती से निश्चित होता है। जब कोई bank transfer वापस करता है, तो payout.failed, payout.success के बाद आ सकता है; और जब कोई failed payout बाद में recover हो जाता है, तो payout.success, payout.failed के बाद आ सकता है। Payload में मौजूद status field को current state मानें, न कि यह मानें कि आपको प्राप्त हुआ अंतिम event ही final है।

Payout Status

Payout object एक single field के माध्यम से अपनी progress report करता है:
Payload में मौजूद refunds, chargebacks और tax deprecated हैं। इसके बजाय विस्तृत breakdown के लिए payout breakup endpoints का उपयोग करें।

संबंधित

Payout Structure

Payouts कैसे schedule और calculate किए जाते हैं, और प्रत्येक payout status का क्या अर्थ है।

Balances & Wallets

Wallet balances और प्रत्येक payout के पीछे मौजूद ledger को track करें।

Webhook Payload Schema

amount
integer<int64>
आवश्यक

The total amount of the payout.

business_id
string
आवश्यक

The unique identifier of the business associated with the payout.

chargebacks
integer<int64>
आवश्यक
अप्रचलित

The total value of chargebacks associated with the payout.

created_at
string<date-time>
आवश्यक

The timestamp when the payout was created, in UTC.

currency
enum<string>
आवश्यक

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
fee
integer<int64>
आवश्यक

The fee charged for processing the payout.

payment_method
string
आवश्यक

The payment method used for the payout (e.g., bank transfer, card, etc.).

payout_id
string
आवश्यक

The unique identifier of the payout.

refunds
integer<int64>
आवश्यक
अप्रचलित

The total value of refunds associated with the payout.

status
enum<string>
आवश्यक

The current status of the payout.

उपलब्ध विकल्प:
not_initiated,
in_progress,
on_hold,
failed,
success
tax
integer<int64>
आवश्यक
अप्रचलित

The tax applied to the payout.

updated_at
string<date-time>
आवश्यक

The timestamp when the payout was last updated, in UTC.

name
string | null

The name of the payout recipient or purpose.

payout_document_url
string | null

The URL of the document associated with the payout.

remarks
string | null

Any additional remarks or notes associated with the payout.

अंतिम संशोधन 6 अगस्त 2026