Webhooks

Payment Method

Notification kinds

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhookNotification.getKind() for Payment Method webhooks will be one of the following:

WebhookNotification.Kind.PAYMENTMETHODREVOKEDBYCUSTOMER
WebhookNotification.Kind.PAYMENTMETHODCUSTOMERDATAUPDATED

The following table describes the conditions that trigger each kind of webhook.

Notification Type	Description
payment_method_revoked_by_customer	A payment instrument that was previously enabled has been revoked by the customer or by Venmo. Currently this webhook will only be sent when a customer cancels their PayPal billing agreement, removes their Venmo connection , or when Venmo suspends the account due to suspicious activity on the customer's Venmo account.
payment_method_customer_data_updated	A payment method's customer data has been updated. Currently, the only trigger for this webhook is when a customer updates their Enriched Customer Data in Venmo, provided that the merchant has enabled the feature.

Attributes

getKind()enum

The kind of webhook notification.

getTimestamp()date

The UTC time at which the webhook was triggered.

getRevokedPaymentMethodMetadata()

Metadata referencing the revoked payment method.

getToken()string

An alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).

getCustomerId()string

A value representing an existing customer stored in your Vault. Use Customer: Findcall to look up a single customer.

getRevokedPaymentMethod()

The PaymentMethod object associated with the revoked payment method.

getPaymentMethodCustomerDataUpdatedMetadata()

Metadata referencing the payment method whose customer data was updated.

getToken()string

An alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).

getPaymentMethod()

The payment method including the customer data that was updated.

getDatetimeUpdated()string

Timestamp of the customer data update.

getEnrichedCustomerData()

Collection of fields encompassing the Enriched Customer Data feature.

getProfileData()

Collection of fields encompassing the customer's profile data.

getUsername()string

The customer's Venmo username.

getFirstName()string

The customer's first name.

getLastName()string

The customer's last name.

getPhoneNumber()string

The customer's phone number.

getEmail()string

The customer's email.

getBillingAddress()

Collection of fields encompassing the customer's billing address.

getStreetAddress()string

The billing address building number and street name.

getExtendedAddress()string

The billing address additional information.

getLocality()string

The billing address locality.

getRegion()string

The billing address region.

getPostalCode()string

The billing address postal code.

getShippingAddress()

Collection of fields encompassing the customer's shipping address.

getStreetAddress()string

The shipping address building number and street name.

getExtendedAddress()string

The shipping address additional information.

getLocality()string

The shipping address locality.

getRegion()string

The shipping address region.

getPostalCode()string

The shipping address postal code.

getFieldsUpdated()Array

Array containing which fields from the data collection were updated, triggering the webhook.