API Overview

Webhooks Implementation Guide
- Limited Availability Release
- Recent Revisions to This Document
- VISA Platform Connect: Specifications and Conditions for Resellers/Partners

Introducing Webhooks
- Webhooks Benefits
- Webhooks Requirements
- Webhooks Workflow Options

Set Up Webhooks
- Subscribing to Webhooks Using Mutual Trust
  - Setting Up Server Security
  - Create a Shared Secret Key Pair
  - Requesting a Digital Signature Key
    - Required Fields for Requesting a Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Products and Events
    - Requesting a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribing to Webhooks Using Mutual Trust
    - Required Fields for Subscribing to Webhooks Using Mutual Trust
    - Optional Fields for Subscribing to Webhooks Using Mutual Trust
    - Example: Creating a Webhook Subscription Using Mutual Trust
    - Notification Scope
    - Health Check URL
    - Subscription Status
    - Product and Event Types
  - Notification Format
    - Example: Notification Payload
- Subscribing to Webhooks Using OAuth
  - Setting Up Server Security
  - Create a Shared Secret Key Pair
  - Requesting a Digital Signature Key
    - Required Fields for Requesting a Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Sending OAuth Credentials
    - Required Fields for Sending Your OAuth Credentials
    - Example: Sending Your OAuth Credentials
  - Products and Events
    - Requesting a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribing to Webhooks Using OAuth
    - Required Fields for Subscribing to Webhooks Using OAuth
    - Optional Fields for Subscribing to Webhooks Using OAuth
    - Example: Creating a Webhook Subscription Using OAuth
    - Notification Scope
    - Health Check URL
    - Subscription Status
    - Product and Event Types
  - Notification Format
    - Example: Notification Payload
- Subscribing to Webhooks Using OAuth with JWT
  - Setting Up Server Security
  - Create a P12 File
  - Requesting a Digital Signature Key
    - Required Fields for Requesting a Digital Signature Key
    - Example: Requesting a Digital Signature Key
  - Sending OAuth Credentials
    - Required Fields for Sending Your OAuth Credentials
    - Example: Sending Your OAuth Credentials
  - Products and Events
    - Requesting a List of Products and Events
    - Example: Requesting a List Products and Event
  - Subscribe to Webhooks Using OAuth with JWT
    - Required Fields for Subscribing to Webhooks Using OAuth with JWT
    - Optional Fields for Subscribing to Webhooks Using OAuth with JWT
    - Example: Creating a Webhook Subscription Using OAuth with JWT
    - Notification Scope
    - Health Check URL
    - Subscription Status
    - Product and Event Types
  - Notification Format
    - Example: Notification Payload

Managing Subscriptions
- Retrieving the Details of a Webhook Subscription
  - Example: Retrieving the Details of a Webhook Subscription
- Retrieving an Organization's Subscriptions Using the Product and Event
  - Required Query Parameters for Retrieving an Organization's Subscriptions Using the Product and Event
  - Example: Retrieving an Organization's Subscriptions Using the Product and Event
- Updating a Webhook Subscription
  - Example: Updating a Webhook Subscription
- Deleting a Webhook Subscription
  - Example: Deleting a Webhook Subscription

Troubleshooting Webhook Subscriptions

Create REST API Keys
- Create a P12 File
- Create a Shared Secret Key Pair

Product and Event Types

Optional Tasks
- Notification Validation
  - Digital Signature Format
  - Validating a Notification
  - Example: Validating a Notification
- Retry Policy
  - Example: Retry Policy in a Subscription Request
- Testing API Requests
  - Triggering a Test Webhook Notification Using the Token Management Service

Updating a Webhook Subscription

To update a webhook subscription, send a PATCH request. Include only the fields that you want to update.

To request the service, use the endpoint specified below. After you send the request, check the response message to verify that the request was successful. A 200-level response code indicates success.

For information about response codes, see

Transaction Response Codes

.

Endpoint

Test:

PATCH apitest.cybersource.com/notification-subscriptions/v1/webhooks/{webhookId}

Production:

PATCH api.cybersource.com/notification-subscriptions/v1/webhooks/{webhookId}

Production in India:

PATCH api.in.cybersource.com/notification-subscriptions/v1/webhooks/{webhookId}

Example: Updating a Webhook Subscription

        Update Webhook

        {
  "name": "My Sample Webhook",
  "description": "Sample decision manager webhook reject event.",
  "products": [
    {
      "productId": "decisionManager",
      "eventTypes": [
        "risk.profile.decision.reject"
      ]
    }
  ],
  "webhookUrl": "https://MyWebhookServer.com:java.io.PrintWriter@4b9e8b7d
8443:/simulateClient",
  "healthCheckUrl": "https://MyWebhookServer.com:8443:/simulateClientHealthCheck",
  "notificationScope": {
    "scope": "CUSTOM"
  }
}