Skip to main content
WEBHOOK
Required permissions:
  • payout:destination:read
  • webhook_receive:payout_methods

헤더

webhook-id
string
필수

A unique identifier for this webhook request

예시:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

webhook-signature
string
필수

The signature of the webhook request with the webhook version prepended

예시:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp
string
필수

The timestamp in seconds since the Unix epoch that the webhook was sent at on the server

예시:

"1727606400"

본문

application/json
api_version
string
필수

The API version for this webhook

Allowed value: "v1"
예시:

"v1"

api_version_date
string | null
필수

The dated API version (Api-Version-Date) the payload is serialized to

예시:

"2026-07-20"

data
object
필수

A configured payout destination where a user receives earned funds, such as a bank account or digital wallet.

id
string
필수

A unique ID for every single webhook request

예시:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

timestamp
string<date-time>
필수

The timestamp in ISO 8601 format that the webhook was sent at on the server

예시:

"2025-01-01T00:00:00.000Z"

type
string
필수

The webhook event type

Allowed value: "payout_method.created"
예시:

"payout_method.created"

company_id
string | null

The account ID that this webhook event is associated with

예시:

"biz_xxxxxxxxxxxxxx"

previous_attributes
object

For some .updated events, the old values of the payload fields that changed, keyed by field name. Omitted when no capture is available for the event

응답

200

Return a 200 status to indicate that the data was received successfully