General/
Webhooks/
Payment Method

Payment Method

Notification kindsAnchorIcon

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

  • WebhookKind.PAYMENTMETHODREVOKEDBYCUSTOMER
  • WebhookKind.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.

AttributesAnchorIcon

Kindenum
The kind of webhook notification.
Timestampdate
The UTC time at which the webhook was triggered.
RevokedPaymentMethodMetadata

Metadata referencing the revoked payment method.

Tokenstring
An alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).
CustomerIdstring
A value representing an existing customer stored in your Vault. Use Customer: Findcall to look up a single customer.
RevokedPaymentMethod
The PaymentMethod object associated with the revoked payment method.
PaymentMethodCustomerDataUpdatedMetadata

Metadata referencing the payment method whose customer data was updated.

Tokenstring
An alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).
PaymentMethod
The payment method including the customer data that was updated.
DatetimeUpdatedstring
Timestamp of the customer data update.
EnrichedCustomerData
Collection of fields encompassing the Enriched Customer Data feature.
ProfileData
Collection of fields encompassing the customer's profile data.
Usernamestring
The customer's Venmo username.
FirstNamestring
The customer's first name.
LastNamestring
The customer's last name.
PhoneNumberstring
The customer's phone number.
Emailstring
The customer's email.
BillingAddress
Collection of fields encompassing the customer's billing address.
StreetAddressstring
The billing address building number and street name.
ExtendedAddressstring
The billing address additional information.
Localitystring
The billing address locality.
Regionstring
The billing address region.
PostalCodestring
The billing address postal code.
ShippingAddress
Collection of fields encompassing the customer's shipping address.
StreetAddressstring
The shipping address building number and street name.
ExtendedAddressstring
The shipping address additional information.
Localitystring
The shipping address locality.
Regionstring
The shipping address region.
PostalCodestring
The shipping address postal code.
FieldsUpdatedArray
Array containing which fields from the data collection were updated, triggering the webhook.