Braintree Auth (Beta)

Webhooksanchor

availability

Braintree Auth is in closed beta. Contact us to express interest.

Webhooks allow Braintree to push messages to your servers when you configure a webhook endpoint URL. If you support new Braintree account signups in your Braintree Auth integration, you can subscribe to webhooks that alert you to important events happening with the connected merchant's account.

We currently provide four webhooks for new Braintree merchant accounts created via Braintree Auth:

Before you get startedanchor

If you are not using webhooks already, follow the general webhooks guide to configure webhooks in your gateway.

note

The bt_signature and bt_payload variables in the code snippets below represent parameters received from the webhook POST request. For more information, read the documentation on parsing webhooks.

Connected merchant underwriting statusanchor

This webhook notifies you when a connected merchant's underwriting status has changed or they have submitted an application:

  1. Callback
  2. Promise
const gateway = new braintree.BraintreeGateway({
  publicKey: 'use_your_public_key',
  privateKey: 'use_your_private_key',
  merchantId: 'use_your_merchant_id',
  environment: braintree.Environment.Sandbox,
});

gateway.webhookNotification.parse(btSignature, btPayload, (err, notification) => {
  notification.kind
  // braintree.notification.Kind.ConnectedMerchantStatusTransitioned

  notification.connectedMerchantStatusTransitioned.status
  // "approved"

  notification.connectedMerchantStatusTransitioned.merchantId
  // "merchant_id"

  notification.connectedMerchantStatusTransitioned.oauthApplicationClientId
  // "oauth_application_client_id"
});

The following status transitions trigger a webhook:

Status Description
approved A merchant has been approved for a Braintree account. All funds from settled transctions will be disbursed to the merchant's bank account.
denied A merchant has been denied. All settled transactions will be refunded.
application_submitted A merchant has submitted their application to Braintree. The merchant can now accept payments to a limit - 25 transactions or up to $2500. Funds will not be disbursed until the merchant is approved.
under_review A merchant application is being reviewed.
inactive A merchant decided to not move forward with the underwriting process. This also occurs if a trial merchant has not submitted an application within 30 days of processing their first payment.

PayPal account status changedanchor

This webhook notifies you when a connected merchant's PayPal account has been successfully linked or unlinked to their Braintree gateway.

  1. Callback
  2. Promise
const gateway = new braintree.BraintreeGateway({
  publicKey: 'use_your_public_key',
  privateKey: 'use_your_private_key',
  merchantId: 'use_your_merchant_id',
  environment: braintree.Environment.Sandbox,
});

gateway.webhookNotification.parse(btSignature, btPayload, (err, notification) => {
  notification.kind
  // braintree.notification.Kind.ConnectedMerchantPayPalStatusChanged

  notification.connectedMerchantPayPalStatusChanged.action
  // "link"

  notification.connectedMerchantPayPalStatusChanged.merchantId
  // "merchant_id"

  notification.connectedMerchantPayPalStatusChanged.oauthApplicationClientId
  // "oauth_application_client_id"
});

The following linking actions trigger a webhook:

Action Description
link A connected merchant has connected a PayPal account to their gateway and can accept PayPal payments.
unlink A connected merchant has disconnected the PayPal account from their gateway. They can no longer accept PayPal payments until they link another PayPal account to their gateway.

Disputesanchor

This webhook notifies you when a connected merchant receives a dispute on a transaction.

important

You must request the oauth_app_receive_dispute_webhooks scope before you can receive these webhooks.

  1. Callback
  2. Promise
const gateway = new braintree.BraintreeGateway({
  publicKey: 'use_your_public_key',
  privateKey: 'use_your_private_key',
  merchantId: 'use_your_merchant_id',
  environment: braintree.Environment.Sandbox,
});

gateway.webhookNotification.parse(btSignature, btPayload, (err, notification) => {
  notification.kind
  // braintree.notification.Kind.DisputeOpened

  notification.sourceMerchantId
  // "source_merchant_id"

  notification.dispute.status
  // "open"
});

Refer to the Dispute webhooks reference for all of the available properties on dispute objects.

OAuth access revokedanchor

This webhook notifies you when the connected merchant has revoked access to their account.

  1. Callback
  2. Promise
const gateway = new braintree.BraintreeGateway({
  publicKey: 'use_your_public_key',
  privateKey: 'use_your_private_key',
  merchantId: 'use_your_merchant_id',
  environment: braintree.Environment.Sandbox,
});

gateway.webhookNotification.parse(btSignature, btPayload, (err, notification) => {
  notification.kind
  // braintree.notification.Kind.OAuthAccessRevoked

  notification.oauthAccessRevocation.merchantId
  // "merchant_id"
});

See also


Next Page: Merchant API