Notification kinds

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. For a Disbursement webhook, $webhookNotification->kind will be one of the following:

  • Braintree_WebhookNotification::DISBURSEMENT
  • Braintree_WebhookNotification::DISBURSEMENT_EXCEPTION
  • Braintree_WebhookNotification::TRANSACTION_DISBURSED

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

Notification Type Description
disbursement

Braintree-funded merchant accounts only

We have sent a disbursement to your account (meaning it will leave our bank account today). The difference between this and a transaction_disbursed webhook is that this is sent per merchant account per day, rather than per transaction.

disbursement_exception

Braintree Marketplace master merchants only

A disbursement to one of your sub-merchants has failed.

This webhook is not triggered when we attempt to disburse funds to a Venmo account that does not exist. See our Braintree Marketplace Funding article for details.

transaction_disbursed

Braintree-funded merchant accounts only
Deprecated

A transaction has been marked for disbursement (meaning it will leave our bank account today).

Attributes

kind enum

The kind of webhook notification.

timestamp date

The UTC time at which the webhook was triggered.

disbursement
id string

The id of the disbursement.

amount decimal

The amount of the disbursement.

disbursementDate date

The date the funds were disbursed.

transactionIds Array

The ids of all transactions associated with this disbursement.

merchantAccount

The merchant account the disbursement corresponds to. You will only receive a disbursement webhook if Braintree manages funding for the selected merchant account. You'll know this is the case if Disbursement Summary reports are available for that account.

retry bool

true if the disbursement previously failed and this webhook is for a second attempt. false if this is the first time this disbursement has been attempted, and false for disbursement exception webhooks.

success bool

true if the disbursement was successful.

exceptionMessage string

Only present for disbursement exception webhooks. indicates the type of failure:

  • bank_rejected
  • insufficient_funds
  • account_not_authorized
followUpAction string

Only present for disbursement exception webhooks. Indicates what (if any) action you should take

  • contact_us
  • update_funding_information
  • none

Still have questions?

If you can’t find an answer, contact our Support team.