Notification kinds

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The $webhookNotification->kind for Grant API webhooks will be one of the following:

  • BraintreeWebhookNotification::GRANTOR_UPDATED_GRANTED_PAYMENT_METHOD
  • BraintreeWebhookNotification::RECIPIENT_UPDATED_GRANTED_PAYMENT_METHOD
  • BraintreeWebhookNotification::GRANTED_PAYMENT_METHOD_REVOKED

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

Notification Type Description
granted_payment_instrument_update

A payment instrument that was previously granted to another Braintree merchant has been updated. The kind will either be GRANTOR_UPDATED_GRANTED_PAYMENT_METHOD or RECIPIENT_UPDATED_GRANTED_PAYMENT_METHOD depending on which side of the relationship the webhook is being sent to.
granted_payment_instrument_revoked

A payment instrument that was previously granted has been revoked by the grantor.

Attributes

kind enum

The kind of webhook notification.
timestamp date

The UTC time at which the webhook was triggered.
revokedPaymentMethodMetadata

Only present for granted payment instrument revoked webhooks.
token string

An alphanumeric value that references a specific payment method stored in your Vault.
customerId string

A value representing an existing customer’s payment method stored in your Vault. Use Customer::find() call to look up a single customer.
revokedPaymentMethod

The PaymentMethod object associated with the revoked granted payment method.
grantedPaymentInstrumentUpdate

Only present for granted payment instrument updated webhooks.
grantOwnerMerchantId string

The merchant ID of the Braintree merchant that owns the payment instrument.
grantRecipientMerchantId string

The merchant ID of the Braintree merchant that was granted the payment instrument.
paymentMethodNonce object

An object containing the payment method nonce, which represents the updated payment instrument.
nonce string

A payment method nonce representing the updated payment instrument.
consumed boolean

A value that indicates if the payment method nonce has been used.
updatedFields Array

An array of strings denoting all of the fields of the payment instrument that were updated.

See the Grant API webhooks guide for additional attributes specific to each webhook kind.