Webhooks
Payment Method
Notification kinds
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.PAYMENTMETHODREVOKEDBYCUSTOMERWebhookKind.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
KindenumThe kind of webhook notification.
TimestampdateThe UTC time at which the webhook was triggered.
RevokedPaymentMethodMetadataMetadata referencing the revoked payment method.
TokenstringAn alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).
CustomerIdstringA value representing an existing customer stored in your Vault. Use Customer: Findcall to look up a single customer.
RevokedPaymentMethodPaymentMethodCustomerDataUpdatedMetadataMetadata referencing the payment method whose customer data was updated.
TokenstringAn alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).
PaymentMethodThe payment method including the customer data that was updated.
DatetimeUpdatedstringTimestamp of the customer data update.
EnrichedCustomerDataCollection of fields encompassing the Enriched Customer Data feature.
ProfileDataCollection of fields encompassing the customer's profile data.
UsernamestringThe customer's Venmo username.
FirstNamestringThe customer's first name.
LastNamestringThe customer's last name.
PhoneNumberstringThe customer's phone number.
EmailstringThe customer's email.
BillingAddressCollection of fields encompassing the customer's billing address.
StreetAddressstringThe billing address building number and street name.
ExtendedAddressstringThe billing address additional information.
LocalitystringThe billing address locality.
RegionstringThe billing address region.
PostalCodestringThe billing address postal code.
ShippingAddressCollection of fields encompassing the customer's shipping address.
StreetAddressstringThe shipping address building number and street name.
ExtendedAddressstringThe shipping address additional information.
LocalitystringThe shipping address locality.
RegionstringThe shipping address region.
PostalCodestringThe shipping address postal code.
FieldsUpdatedArrayArray containing which fields from the data collection were updated, triggering the webhook.