Notification kinds

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

  • WebhookNotification.Kind.GRANTOR_UPDATED_GRANTED_PAYMENT_METHOD
  • WebhookNotification.Kind.RECIPIENT_UPDATED_GRANTED_PAYMENT_METHOD
  • WebhookNotification.Kind.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

getKind() enum

The kind of webhook notification.

getTimestamp() date

The UTC time at which the webhook was triggered.

getRevokedPaymentMethodMetadata()

Only present for granted payment instrument revoked webhooks.

getToken() string

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

getCustomerId() string

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

getRevokedPaymentMethod()

The PaymentMethod object associated with the revoked granted payment method.

getGrantedPaymentInstrumentUpdate()

Only present for granted payment instrument updated webhooks.

getGrantOwnerMerchantId() string

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

getGrantRecipientMerchantId() string

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

getPaymentMethodNonce() object

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

getNonce() string

A payment method nonce representing the updated payment instrument.

getConsumed() boolean

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

getUpdatedFields() 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.