General/
Webhooks/
Grant API

Grant API

Notification kindsAnchorIcon

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::GRANTORUPDATEDGRANTEDPAYMENTMETHOD
  • BraintreeWebhookNotification::RECIPIENTUPDATEDGRANTEDPAYMENTMETHOD
  • BraintreeWebhookNotification::GRANTEDPAYMENTMETHODREVOKED

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

Notification TypeDescription
granted_payment_instrument_update

A payment instrument that was previously granted to another Braintree merchant has been updated. The kind will either be GrantorUpdatedGrantedPaymentMethod or RecipientUpdatedGrantedPaymentMethod 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.

AttributesAnchorIcon

kindenum
The kind of webhook notification.
timestampdate
The UTC time at which the webhook was triggered.
revokedPaymentMethodMetadata

Only present for granted payment instrument revoked webhooks.

tokenstring
An alphanumeric value that references a specific payment method stored in your Vault.
customerIdstring
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.

grantOwnerMerchantIdstring
The merchant ID of the Braintree merchant that owns the payment instrument.
grantRecipientMerchantIdstring
The merchant ID of the Braintree merchant that was granted the payment instrument.
paymentMethodNonceobject
An object containing the payment method nonce, which represents the updated payment instrument.
noncestring
A payment method nonce representing the updated payment instrument.
consumedboolean
A value that indicates if the payment method nonce has been used.
updatedFieldsArray
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.