Webhooks
Payment Method
Notification kinds
The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhook_notification.kind for Payment Method webhooks will be one of the following:
Braintree::WebhookNotification::Kind::PaymentMethodRevokedByCustomerBraintree::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
kindenumThe kind of webhook notification.
timestampdateThe UTC time at which the webhook was triggered.
revoked_payment_method_metadataMetadata referencing the revoked payment method.
tokenstringAn alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).
customer_idstringA value representing an existing customer stored in your Vault. Use Customer: Findcall to look up a single customer.
revoked_payment_methodpayment_method_customer_data_updated_metadataMetadata 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).
payment_methodThe payment method including the customer data that was updated.
datetime_updatedstringTimestamp of the customer data update.
enriched_customer_dataCollection of fields encompassing the Enriched Customer Data feature.
profile_dataCollection of fields encompassing the customer's profile data.
usernamestringThe customer's Venmo username.
first_namestringThe customer's first name.
last_namestringThe customer's last name.
phone_numberstringThe customer's phone number.
emailstringThe customer's email.
billing_addressCollection of fields encompassing the customer's billing address.
street_addressstringThe billing address building number and street name.
extended_addressstringThe billing address additional information.
localitystringThe billing address locality.
regionstringThe billing address region.
postal_codestringThe billing address postal code.
shipping_addressCollection of fields encompassing the customer's shipping address.
street_addressstringThe shipping address building number and street name.
extended_addressstringThe shipping address additional information.
localitystringThe shipping address locality.
regionstringThe shipping address region.
postal_codestringThe shipping address postal code.
fields_updatedArrayArray containing which fields from the data collection were updated, triggering the webhook.