Pay Link payout updated webhook
PAYLINK_PAYOUT_UPDATED is sent when a Pay Link’s payout changes: a recipient wallet, its currency or its source chain, or a split wallet’s address or percentage while split payments are on. Use it to alert on unexpected changes to where your payments go.
A change that leaves the payout the same, such as renaming the Pay Link or reordering its recipients, does not send the event.
This is an opt-in Pay Link webhook event. Subscribing to ALL, REGULAR_ALL, or REGULAR_TRANSACTION does not include it.
Subscribe
Create a webhook withPAYLINK_PAYOUT_UPDATED in optInEvents:
paylinkId for a specific Pay Link, or omit it for an account-wide subscription. The webhook also receives the payment events for its scope.
Opt-in events are set when the webhook is created. To add one to an existing webhook, contact support.
Payload
previous and current describe the payout before and after the change. recipients has the same shape as the recipients in the public Pay Link response (abbreviated above). splitWallets is empty while split payments are off.
changedBy says where the change came from:
Handling the event
- If you did not expect the change, check the Pay Link and your team access right away. A
previousvalue tells you what to restore. - Each change sends one event, so successive changes arrive as separate deliveries. Order them by
changedAt.
