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 |
granted_payment_instrument_revoked |
A payment instrument that was previously granted has been revoked by the grantor. |
Attributes
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.
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.
See the Grant API webhooks guide for additional attributes specific to each webhook kind.