Webhook Subscriptions for `Pay by Link` {#paybylink-webhooks-intro}
===================================================================

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. |
[Merchant Webhook Event]

| 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. |
[Partner Reseller Webhook Event]

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*](https://developer.visaacceptance.com/docs/vas/en-us/webhooks/implementation/all/rest/webhooks/wh-fg-intro.md "").

`REST` Example: Create `Pay by Link` Webhook Subscription {#paybylink-webhooks-ex-rest}
=======================================================================================

Request

```
{
  "name": "PBL Webhook Subscription",
  "description": "PBL Webhook for Digital Accept",
  "organizationId": "digital_accept_lab",
  "productId": "payByLink",
  "eventTypes": [
    "payByLink.customer.payment",
    "payByLink.merchant.payment"
  ],
  "webhookUrl": "https://test.com:443/test",
  "healthCheckUrl": "https://test.com:443/test",
  "notificationScope": "SELF",
  "retryPolicy": {
    "algorithm": "ARITHMETIC",
    "firstRetry": 1,
    "interval": 1,
    "numberOfRetries": 3,
    "deactivateFlag": "false",
    "repeatSequenceCount": 0,
    "repeatSequenceWaitTime": 0
  },
  "securityPolicy": {
    "securityType": "KEY",
    "proxyType": "external"
  }
}
```

Response to a Successful Request

```
{
  "organizationId": "digital_accept_lab",
  "productId": "payByLink",
  "eventTypes": [
    "payByLink.customer.payment",
    "payByLink.merchant.payment"
  ],
  "webhookId": "1928667e-f9f7-8a37-e063-9c588e0a7e3b",
  "name": "PBL Webhook Subscription",
  "webhookUrl": "https://test.com:443/test",
  "healthCheckUrl": "https://test.com:443/test",
  "createdOn": "2024-05-23T23:27:54.268Z",
  "status": "INACTIVE",
  "description": "PBL Webhook for Digital Accept",
  "retryPolicy": {
    "algorithm": "ARITHMETIC",
    "firstRetry": 1,
    "interval": 1,
    "numberOfRetries": 3,
    "deactivateFlag": false,
    "repeatSequenceCount": 0,
    "repeatSequenceWaitTime": 0
  },
  "securityPolicy": {
    "securityType": "KEY",
    "proxyType": "external",
    "digitalSignatureEnabled": "yes"
  },
  "version": "3",
  "deliveryType": "nrtdCentral",
  "notificationScope": "SELF"
}
```