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_revoked_by_customer | A payment instrument that was previously enabled has been revoked by the customer or by Venmo. |
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()
enumThe kind of webhook notification.
getTimestamp()
dateThe UTC time at which the webhook was triggered.
getRevokedPaymentMethodMetadata()
Metadata referencing the revoked payment method.
getToken()
stringAn alphanumeric value that references a specific payment method stored in your Vault (used for recurring purchases).
getCustomerId()
stringA value representing an existing customer stored in your Vault. Use Customer: Find call 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()
stringAn 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()
stringTimestamp 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()
stringThe customer's Venmo username.
getFirstName()
stringThe customer's first name.
getLastName()
stringThe customer's last name.
getPhoneNumber()
stringThe customer's phone number.
getEmail()
stringThe customer's email.
getFieldsUpdated()
ArrayArray containing which fields from the data collection were updated, triggering the webhook.