On This Page

Supported Products and Event Types

This section describes all of the products and event types that are supported by the Webhooks REST API.

When you create a webhook subscription, you must include a Visa Acceptance Solutions product
and one of its corresponding event types
in your request. You can include multiple products and event types in the same request. Every time one of the events that you subscribe to occurs, you receive a notification. If you subscribe to a product that is not enabled for your account, you receive a notification when it is enabled. To retrieve a list of the enabled products that your organization can subscribe to, see Retrieve a List of Products and Events.

When you send a create a webhook subscription
request, set the

productId

field to a value listed in the Product ID column. Set the

eventTypes

field array to a value listed in the Event Types column. If you are subscribing to multiple products and event types, separate each value with the comma character (

). For reference examples of how to properly format these fields and values in a request, see Examples of all Products and Event Types.

These are all of the webhook supported products, event types, and their corresponding field values:

Alternative Payment Methods

Product ID	Event Types	Description
alternativePaymentMethods	payments.payments.updated	Notifies you that an alternative payment transaction's status has been updated.

`eCheck`

Product ID	Event Types	Description
eCheck	payments.credits.accepted	Notifies you of a successful `eCheck` credit transaction.
	payments.credits.failed	Notifies you of an `eCheck` credit transaction failure.
	payments.payments.accepted	Notifies you of a successful `eCheck` debit transaction.
	payments.payments.failed	Notifies you of an `eCheck` debit transaction failure.
	payments.voids.accepted	Notifies you of a successful `eCheck` void transaction.
	payments.voids.failed	Notifies you of an `eCheck` void transaction failure.

`Fraud Management Essentials`

Product ID	Event Types	Description
fraudManagementEssentials	risk.casemanagement.decision.accept	Notifies you that a `Fraud Management Essentials` case has been accepted.
	risk.casemanagement.addnote	Notifies you that a note has been added to a `Fraud Management Essentials` case.
	risk.profile.decision.reject	Notifies you that a transaction was rejected.
	risk.casemanagement.decision.reject	Notifies you that a `Fraud Management Essentials` case has been rejected.
	risk.profile.decision.monitor	Notifies you of a profile decision to monitor a transaction.
	risk.profile.decision.review	Notifies you of a profile decision to review a transaction.

Invoicing

Product ID	Event Types	Description
customerInvoicing	invoicing.customer.invoice.send	Notifies you that an invoice has been sent.
	invoicing.customer.invoice.cancel	Notifies you that an invoice has been cancelled.
	invoicing.customer.invoice.paid	Notifies you that an invoice has been paid.
	invoicing.customer.invoice.partial-payment	Notifies you that an invoice has been partially paid.
	invoicing.customer.invoice.reminder	Notifies you 5 days before the invoice payment is due. This event is triggered if you have invoice reminders enabled in your invoice settings.
	invoicing.customer.invoice.overdue-reminder	Notifies you 1 day after the invoice payment is due. This event is triggered if you have invoice reminders enabled in your invoice settings.

Payments

Product ID	Event Types	Description
payments	payments.capture.status.accepted	Notifies you that a payment capture request is accepted by `Visa Acceptance Solutions`.
payments	payments.capture.status.updated	Notifies you that a payment capture is updated.

`Pay by Link`

Product ID	Event Types	Description
payByLink	payByLink.merchant.payment	Merchants can subscribe to this event type to automate how their system is informed when a customer completes a payment.
payByLink	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.

Recurring Billing

Product ID	Event Types	Description
recurringBilling	rbs.subscriptions.charge.failed	Notifies you of a recurring payment failure.
	rbs.subscriptions.charge.pre-notified	Notifies you of an upcoming recurring payment.
	rbs.subscriptions.charge.created	Notifies you of successful recurring payment.

`Token Management Service`

Product ID	Event Types	Description
tokenManagement	tms.networktoken.updated	Notifies you of a network token's change in expiration date or status (suspend, resume, or deactivate).
tokenManagement	tms.networktoken.provisioned	Notifies you when a network token provision for an instrument identifier token has been successful.