Skip to main content
WEBHOOK

Headers

webhook-id
string
vereist

A unique identifier for this webhook request

Voorbeeld:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

webhook-signature
string
vereist

The signature of the webhook request with the webhook version prepended

Voorbeeld:

"v1,BASE64ENCODEDSIGNATURE"

webhook-timestamp
string
vereist

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

Voorbeeld:

"1727606400"

Body

application/json
api_version
string
vereist

The API version for this webhook

Allowed value: "v1"
Voorbeeld:

"v1"

api_version_date
string | null
vereist

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

Voorbeeld:

"2026-07-20"

data
object
vereist
id
string
vereist

A unique ID for every single webhook request

Voorbeeld:

"msg_xxxxxxxxxxxxxxxxxxxxxxxx"

timestamp
string<date-time>
vereist

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

Voorbeeld:

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

type
string
vereist

The webhook event type

Allowed value: "shipping_address.changed"
Voorbeeld:

"shipping_address.changed"

account_id
string | null

The account ID that this webhook event is associated with

Voorbeeld:

"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

Respons

200 - application/json

Your price for this address, or a decline.

line_items
object[]
vereist
shipping_options
object[]
tax
object

The tax you charge at this address, in the currency of data.amount. PayPal shows it on its own Tax line, and the buyer pays it on top of the line totals. Leave it out to keep tax inside the line totals.