Webhooks
Grant API
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.GRANTORUPDATEDGRANTEDPAYMENTMETHOD
WebhookNotification.Kind.RECIPIENTUPDATEDGRANTEDPAYMENTMETHOD
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
getKind()
enumThe kind of webhook notification.
getTimestamp()
dateThe UTC time at which the webhook was triggered.
getRevokedPaymentMethodMetadata()
Only present for granted payment instrument revoked webhooks.
getToken()
stringAn alphanumeric value that references a specific payment method stored in your Vault.
getCustomerId()
stringA 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()
stringThe merchant ID of the Braintree merchant that owns the payment instrument.
getGrantRecipientMerchantId()
stringThe merchant ID of the Braintree merchant that was granted the payment instrument.
getPaymentMethodNonce()
objectAn object containing the payment method nonce, which represents the updated payment instrument.
getNonce()
stringA payment method nonce representing the updated payment instrument.
getConsumed()
booleanA value that indicates if the payment method nonce has been used.
getUpdatedFields()
ArrayAn 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.