Webhooks
Disbursement
Notification kinds
The notification kind, returned by calling Kind on the notification object, reveals what triggered the webhook. The WebhookNotification.Kind for Disbursement webhooks will be one of the following:
WebhookKind.DISBURSEMENT
WebhookKind.DISBURSEMENTEXCEPTION
WebhookKind.TRANSACTIONDISBURSED
The following table describes the conditions that trigger each kind of webhook.
Notification Type | Description |
---|---|
disbursement |
Braintree-funded merchant accounts only |
disbursement_exception |
Braintree Marketplace master merchants only |
transaction_disbursed |
Braintree-funded merchant accounts only |
Attributes
Kind
enumThe kind of webhook notification.
Timestamp
dateThe UTC time at which the webhook was triggered.
Disbursement
Id
stringThe id of the disbursement.
Amount
decimalThe amount of the disbursement.
DisbursementDate
dateThe date the funds were disbursed.
DisbursementType
stringThe type of disbursement (debit/credit).
TransactionIds
ArrayThe 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
booltrue
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
booltrue
if the disbursement was successful.
ExceptionMessage
stringOnly present for disbursement exception webhooks. indicates the type of failure:
bank_rejected
insufficient_funds
account_not_authorized
FollowUpAction
stringOnly present for disbursement exception webhooks. Indicates what (if any) action you should take
contact_us
update_funding_information
none