General/
Webhooks/
Disbursement

Disbursement

Notification kindsAnchorIcon

The notification kind, returned by calling kind on the notification object, reveals what triggered the webhook. The webhook_notification.kind for Disbursement webhooks will be one of the following:
  • Braintree::WebhookNotification::Kind::Disbursement
  • Braintree::WebhookNotification::Kind::TransactionDisbursed

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

Notification TypeDescription
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.

transaction_disbursed

Braintree-funded merchant accounts only
Deprecated
A transaction has been marked for disbursement (meaning it will leave our bank account today).

AttributesAnchorIcon

kindenum
The kind of webhook notification.
timestampdate
The UTC time at which the webhook was triggered.
disbursement
idstring
The id of the disbursement.
amountdecimal
The amount of the disbursement.
disbursement_datedate
The date the funds were disbursed.
disbursement_typestring
The type of disbursement (debit/credit).
transaction_idsArray
The ids of all transactions associated with this disbursement.
merchant_account
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.
retrybool
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.
success?bool
true if the disbursement was successful.