Webhooks
Grant API
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:
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.
revokedPaymentMethodMetadataOnly present for granted payment instrument revoked webhooks.
tokenstringAn alphanumeric value that references a specific payment method stored in your Vault.
customerIdstringA value representing an existing customer's payment method stored in your Vault. Use
Customer: Find call to look up a single customer.revokedPaymentMethodgrantedPaymentInstrumentUpdateOnly present for granted payment instrument updated webhooks.
grantOwnerMerchantIdstringgrantRecipientMerchantIdstringpaymentMethodNonceobjectAn 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.
updatedFieldsArrayAn 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.