On This Page

Create a Sample Webhook Subscription

Follow these steps to create a sample webhook subscription and then trigger a test webhook notification. This sample subscription uses the
Token Management Service
 (
TMS
).
IMPORTANT
You must first confirm that your organization ID is enabled for
TMS
 and that a
TMS
 vault is set up. For assistance, contact
Visa Acceptance Solutions
 Customer Support.
  1. Create a
    TMS
     webhook subscription for your organization ID using this endpoint:
    POST
    https://apitest.visaacceptance.com
    /notification-subscriptions/v2/webhooks
    Set the
    productId
     field to
    tokenManagement
     and the
    eventTypes
     field to
    tms.networktoken.provisioned
    . This example creates a webhook subscription using Mutual trust, which is the default security policy.
    {
  "name": "TMS Webhook",
  "description": "Sample TMS Webhook from Developer Center",
  "organizationId": "organizationId",
  "productId": "tokenManagement",
  "eventTypes": [
    "tms.networktoken.provisioned"
  ],
  "webhookUrl": "https://MyWebhookServer.com:8443/simulateClient",
  "healthCheckUrl": "https://MyWebhookServer.com:8443/simulateClientHealthCheck",
  "notificationScope": "SELF",
  "retryPolicy": {
    "algorithm": "ARITHMETIC",
    "firstRetry": 1,
    "interval": 1,
    "numberOfRetries": 3,
    "deactivateFlag": "false",
    "repeatSequenceCount": 0,
    "repeatSequenceWaitTime": 0
  },
  "securityPolicy": {
    "securityType": "KEY",
    "proxyType": "external"
  }
}
  2. On the left-hand navigation panel, choose
    Tokenization > Token Management > Instrument Identifier > Create an Instrument Identifier
    .
  3. Click the
    Configuration
     tab.
  4. In the Sample Request drop-down menu, choose
    Create Instrument Identifier using a Card and Create Network Token
    :
  5. Set the
    card.number
     field to a test PAN. Contact
    Visa Acceptance Solutions
     customer support for a test PAN. Send the request to this endpoint:
    POST
    https://apitest.visaacceptance.com
    /tms/v1/instrumentidentifiers
     
    {
  "type": "enrollable card",
  "card": {
    "number": "411111111111XXXX",  // Replace the ‘X’s with 1
    "expirationMonth": "12",
    "expirationYear": "2031"
  }
}
    IMPORTANT
    A test PAN can only have one associated instrument identifier. If you need to test multiple webhook notifications, delete the instrument identifier created for that PAN before using the
    Delete an Instrument Identifier API
    .
  6. Click
    Send
    . After you receive a successful response, your system should receive a webhook event notification.