Skip to main content
Payout webhook は、ユーザー自身の資金が Dodo Payments から銀行口座へ移動したタイミングを通知します。これらを使用すると、Payouts の一覧 エンドポイントをポーリングせずに、会計システム内で Payout を照合できます。

Payout Webhook イベント

Payout はライフサイクルの各段階でイベントを発行します。各段階は、ダッシュボードに表示される Payout のステータス に対応しています。
payout.created は以前、payout.not_initiated として発行されていました。既存のエンドポイントが payout.not_initiated でフィルタリングしている場合は、引き続き一致するようにフィルターを payout.created に更新してください。ペイロードの status フィールドは、この段階でも not_initiated を報告します。

Payout イベントの処理

Payout は顧客の資金ではなくユーザー自身の資金に関するものなので、これらのイベントは通常、顧客向けのフローではなく、帳簿管理や社内アラートに使用されます。
Handling payout events
処理する前に、必ず webhook の署名を検証してください。設定方法については Webhooks ガイド を参照してください。上記のハンドラーでは、簡潔にするため検証を省略しています。
Payout イベントは終端イベントではなく、厳密な順序で発生するわけでもありません。銀行が送金を返却した場合、payout.failedpayout.success の後に届くことがあります。また、失敗した Payout が後から復旧した場合は、payout.successpayout.failed の後に届くことがあります。最後に受信したイベントが確定したものだと想定せず、ペイロードの status フィールドを現在の状態として扱ってください。

Payout のステータス

Payout オブジェクトは、1 つのフィールドで進行状況を報告します。
ペイロードの refundschargebackstax は非推奨です。詳細な内訳については、代わりに Payout 内訳エンドポイント を使用してください。

関連情報

Payout Structure

Payout のスケジュールと計算方法、および各 Payout ステータスの意味について説明します。

Balances & Wallets

ウォレット残高と、各 Payout の基盤となる台帳を確認します。

Webhook ペイロードスキーマ

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.

最終更新日 2026年8月6日