v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB

Payment Links

Payment Links Notification

This is an outbound HTTP POST message from the Shift4 gateway to the merchant's environment that provides a status of the Payment Links request. This notification request will be sent from Shift4 to the URL provided in the merchant's boarding configuration.

This requires the interface vendor to establish a listening service to receive these requests.

postWebhookpaymentlinks-notification

Payload

dateTimestring ISO 8601

Date-time when the object was created

metadataPaymentLinksMetadata

Key-value object for storing additional custom data.

This is never displayed to customer on the payment page.

Examples: "order_id": "12345" "campaign_code": "SUMMER2025"

Example payload

{
  "dateTime": "2024-05-21T09:18:23.283-07:00",
  "paymentLink": {
    "id": "link_8kdskX8DZ8FR6W3acYPXiyAN",
    "lastOpened": "2025-10-20T11:22:33.444Z",
    "lineItems": [
      {
        "product": {
          "name": "Example charge",
          "description": "Some product description",
          "currencyCode": "USD",
          "amount": {
            "total": 10
          }
        }
      }
    ],
    "currency": "USD",
    "url": "https://pay.shift4.com/link_8kdskX8DZ8FR6W3acYPXiyAN",
    "restrictions": {
      "dates": {
        "activatesAt": "2025-10-20T11:22:33.444Z",
        "expiresAt": "2025-10-27T12:00:00.000Z"
      },
      "payments": {
        "limit": 1
      }
    },
    "notifications": {
      "share": {
        "email": {
          "emailAddress": "john@example.com"
        }
      }
    },
    "staticFields": {
      "Date of event": "12 April",
      "Invoice number": "ABC2016"
    },
    "customFieldsTitle": "Additional information",
    "customFields": [
      {
        "key": "special_wishes",
        "label": "Special wishes"
      }
    ],
    "vendorReference": "ref_123456789"
  },
  "customer": {
    "id": "cust_oM1i4j7EsIY7W5vqqF76diGw",
    "emailAddress": "john@example.com",
    "phoneCountry": "US",
    "phoneNumber": "+1 2345678901",
    "addressLine1": "65 Easy St",
    "firstName": "John",
    "middleName": "Andrew",
    "lastName": "Smith",
    "postalCode": "65144",
    "addressCity": "New York",
    "addressRegion": "NY",
    "addressCountry": "US"
  },
  "metadata": {
    "order_id": "12345",
    "campaign_code": "SUMMER2025"
  }
}

Response

Return 200 status to indicate that the Notification was received successfully.