Webhooks for Pay by Link
Pay by Link
Webhooks are automated notifications generated by system events that occur in your
organization. You can subscribe to these event types to receive a notification when a
customer makes a payment. Set the
eventTypes
request field to one of
the values shown in these tables. Event Type Field Value | Description |
|---|---|
payByLink.merchant.payment | Merchants can subscribe to this event type to automate how their
system is informed when a customer completes a payment. |
Event Type Field Value | Description |
|---|---|
payByLink.customer.payment | Partner resellers can subscribe to this event type to control the
distribution of the payment confirmation email sent to their
merchants' customers. |
Use the example in this section only to reference how to format the
eventTypes
request field and its values.You can designate a destination URL for the webhook notifications.
Notifications that contain sensitive, personally identifiable information such as account
numbers are sent using message-level encryption.
- Prerequisite
- Transport Layer Security is required in order to ensure data integrity.
Additional Requirements
There are additional requirements for implementing webhooks that are not
discussed in this guide. To subscribe to
Pay by Link
webhook
notifications, see the Webhooks Implementation Guide
for the REST
API.