Webhooks
Grant API
Notification kinds
The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhook_notification.kind for Grant API webhooks will be one of the following:
Braintree::WebhookNotification::Kind::GrantorUpdatedGrantedPaymentMethodBraintree::WebhookNotification::Kind::RecipientUpdatedGrantedPaymentMethodBraintree::WebhookNotification::Kind::GrantedPaymentMethodRevoked
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
kindenumThe kind of webhook notification.
timestampdateThe UTC time at which the webhook was triggered.
revoked_payment_method_metadataOnly present for granted payment instrument revoked webhooks.
tokenstringAn alphanumeric value that references a specific payment method stored in your Vault.
customer_idstringA value representing an existing customer's payment method stored in your Vault. Use
Customer: Find call to look up a single customer.revoked_payment_methodgranted_payment_instrument_updateOnly present for granted payment instrument updated webhooks.
grant_owner_merchant_idstringgrant_recipient_merchant_idstringpayment_method_nonceobjectAn object containing the payment method nonce, which represents the updated payment instrument.
noncestringA payment method nonce representing the updated payment instrument.
consumedbooleanA value that indicates if the payment method nonce has been used.
updated_fieldsArrayAn 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.